balber::BerEncoder Class Reference

#include <balber_berencoder.h>

List of all members.

Classes
class	MemOutStream
Public Types
enum	ErrorSeverity { e_BER_SUCCESS = 0x00, e_BER_ERROR = 0x02, BDEM_BER_SUCCESS = e_BER_SUCCESS, BDEM_BER_ERROR = e_BER_ERROR }
Public Member Functions
	BerEncoder (const BerEncoderOptions *options=0, bslma::Allocator *basicAllocator=0)
	~BerEncoder ()
template<typename TYPE >
int	encode (bsl::streambuf *streamBuf, const TYPE &value)
template<typename TYPE >
int	encode (bsl::ostream &stream, const TYPE &value)
const BerEncoderOptions *	options () const
ErrorSeverity	errorSeverity () const
bslstl::StringRef	loggedMessages () const
Friends
struct	BerEncoder_encodeProxy
class	BerEncoder_Visitor
class	BerEncoder_UniversalElementVisitor
class	BerEncoder_LevelGuard

---

Detailed Description

This class contains the parameterized encode functions that encode bdlat types to an outgoing stream in BER format.

See Component balber_berencoder

---

Member Enumeration Documentation

enum balber::BerEncoder::ErrorSeverity

Enumerator:

e_BER_SUCCESS
e_BER_ERROR
BDEM_BER_SUCCESS
BDEM_BER_ERROR

---

Constructor & Destructor Documentation

balber::BerEncoder::BerEncoder	(	const BerEncoderOptions *	options = 0,
		bslma::Allocator *	basicAllocator = 0
	)

Construct an encoder object. Optionally specify encoder options. If options is 0, BerEncoderOptions() is used. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

balber::BerEncoder::~BerEncoder

(

)

Destroy this object. This destruction has no effect on objects pointed-to by the pointers provided at construction.

---

Member Function Documentation

template<typename TYPE >

int balber::BerEncoder::encode	(	bsl::streambuf *	streamBuf,
		const TYPE &	value
	)

Encode the specified non-modifiable value to the specified streamBuf. Return 0 on success, and a non-zero value otherwise.

template<typename TYPE >

int balber::BerEncoder::encode	(	bsl::ostream &	stream,
		const TYPE &	value
	)

Encode the specified non-modifiable value to the specified stream. Return 0 on success, and a non-zero value otherwise. If the encoding fails stream will be invalidated.

const BerEncoderOptions* balber::BerEncoder::options

(

)

const

Return address of the options.

ErrorSeverity balber::BerEncoder::errorSeverity

(

)

const

Return the severity of the most severe warning or error encountered during the last call to the encode method. The severity is reset each time encode is called.

bslstl::StringRef balber::BerEncoder::loggedMessages

(

)

const

Return a string containing any error, warning, or trace messages that were logged during the last call to the encode method. The log is reset each time encode is called.

---

Friends And Related Function Documentation

friend struct BerEncoder_encodeProxy [friend]

friend class BerEncoder_Visitor [friend]

friend class BerEncoder_UniversalElementVisitor [friend]

friend class BerEncoder_LevelGuard [friend]

---

The documentation for this class was generated from the following file:

• balber_berencoder.h