Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET

Apache Qpid Documentation

qpid::messaging Namespace Reference

Classes
class	Address
	Represents an address to which messages can be sent and from which messages can be received. More...
class	Connection
	A connection represents a network connection to a remote endpoint. More...
class	Duration
	A duration is a time in milliseconds. More...
struct	MessagingException
struct	InvalidOptionString
struct	KeyError
struct	LinkError
struct	AddressError
struct	ResolutionError
	Thrown when a syntactically correct address cannot be resolved or used. More...
struct	AssertionFailed
struct	NotFound
struct	MalformedAddress
	Thrown when an address string with inalid sytanx is used. More...
struct	ReceiverError
struct	FetchError
struct	NoMessageAvailable
struct	SenderError
struct	SendError
struct	TargetCapacityExceeded
struct	SessionError
struct	TransactionError
struct	TransactionAborted
struct	UnauthorizedAccess
struct	ConnectionError
struct	TransportFailure
class	FailoverUpdates
	A utility to listen for updates on cluster membership and update the list of known urls for a connection accordingly. More...
class	Handle
	A handle is like a pointer: refers to an underlying implementation object. More...
class	Message
	Representation of a message. More...
struct	EncodingException
class	Receiver
	Interface through which messages are received. More...
class	Sender
	Interface through which messages are sent. More...
class	Session
	A session represents a distinct 'conversation' which can involve sending and receiving messages to and from different addresses. More...
Functions
QPID_MESSAGING_EXTERN std::ostream &	operator<< (std::ostream &out, const Address &address)
QPID_MESSAGING_EXTERN Duration	operator * (const Duration &duration, uint64_t multiplier)
QPID_MESSAGING_EXTERN Duration	operator * (uint64_t multiplier, const Duration &duration)
QPID_MESSAGING_EXTERN void	decode (const Message &message, qpid::types::Variant::Map &map, const std::string &encoding=std::string())
	Decodes message content into a Variant::Map.
QPID_MESSAGING_EXTERN void	decode (const Message &message, qpid::types::Variant::List &list, const std::string &encoding=std::string())
	Decodes message content into a Variant::List.
QPID_MESSAGING_EXTERN void	encode (const qpid::types::Variant::Map &map, Message &message, const std::string &encoding=std::string())
	Encodes a Variant::Map into a message.
QPID_MESSAGING_EXTERN void	encode (const qpid::types::Variant::List &list, Message &message, const std::string &encoding=std::string())
	Encodes a Variant::List into a message.

---

Function Documentation

QPID_MESSAGING_EXTERN std::ostream& qpid::messaging::operator<<	(	std::ostream &	out,
		const Address &	address
	)

QPID_MESSAGING_EXTERN Duration qpid::messaging::operator *	(	const Duration &	duration,
		uint64_t	multiplier
	)

QPID_MESSAGING_EXTERN Duration qpid::messaging::operator *	(	uint64_t	multiplier,
		const Duration &	duration
	)

QPID_MESSAGING_EXTERN void qpid::messaging::decode	(	const Message &	message,
		qpid::types::Variant::Map &	map,
		const std::string &	encoding = std::string()
	)

Decodes message content into a Variant::Map.

Parameters:

	message	the message whose content should be decoded
	map	the map into which the message contents will be decoded
	encoding	if specified, the encoding to use - this overrides any encoding specified by the content-type of the message

Exceptions:

EncodingException

QPID_MESSAGING_EXTERN void qpid::messaging::decode	(	const Message &	message,
		qpid::types::Variant::List &	list,
		const std::string &	encoding = std::string()
	)

Decodes message content into a Variant::List.

Parameters:

	message	the message whose content should be decoded
	list	the list into which the message contents will be decoded
	encoding	if specified, the encoding to use - this overrides any encoding specified by the content-type of the message

Exceptions:

EncodingException

QPID_MESSAGING_EXTERN void qpid::messaging::encode	(	const qpid::types::Variant::Map &	map,
		Message &	message,
		const std::string &	encoding = std::string()
	)

Encodes a Variant::Map into a message.

Parameters:

	map	the map to be encoded
	message	the message whose content should be set to the encoded map
	encoding	if specified, the encoding to use - this overrides any encoding specified by the content-type of the message

Exceptions:

EncodingException

QPID_MESSAGING_EXTERN void qpid::messaging::encode	(	const qpid::types::Variant::List &	list,
		Message &	message,
		const std::string &	encoding = std::string()
	)

Encodes a Variant::List into a message.

Parameters:

	list	the list to be encoded
	message	the message whose content should be set to the encoded list
	encoding	if specified, the encoding to use - this overrides any encoding specified by the content-type of the message

Exceptions:

EncodingException

---