qpid::messaging::Sender Class Reference

#include <qpid/messaging/Sender.h>

Public Member Functions
	Sender (SenderImpl *impl=0)
	Sender (const Sender &)
	~Sender ()
Sender &	operator= (const Sender &)
void	send (const Message &message, bool sync=false)
	Sends a message. More...
void	close ()
void	setCapacity (uint32_t)
	Sets the capacity for the sender. More...
uint32_t	getCapacity ()
	Returns the capacity of the sender. More...
uint32_t	getUnsettled ()
	Returns the number of sent messages pending confirmation of receipt by the broker. More...
uint32_t	getAvailable ()
	Returns the number of messages for which there is available capacity. More...
const std::string &	getName () const
	Returns the name of this sender. More...
Session	getSession () const
	Returns a handle to the session associated with this sender. More...
Address	getAddress () const
	Returns an address for this sender. More...
QPID_MESSAGING_INLINE_EXTERN bool	isValid () const
QPID_MESSAGING_INLINE_EXTERN bool	isNull () const
QPID_MESSAGING_INLINE_EXTERN	operator bool () const
	Conversion to bool supports idiom if (handle) { handle->... More...
QPID_MESSAGING_INLINE_EXTERN bool	operator! () const
	Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }. More...
void	swap (Handle< SenderImpl > &h)

Protected Types
typedef SenderImpl	Impl

Protected Attributes
Impl *	impl

Detailed Description

Interface through which messages are sent.

Definition at line 44 of file Sender.h.

Member Typedef Documentation

Impl

typedef SenderImpl qpid::messaging::Handle< SenderImpl >::Impl

protectedinherited

Definition at line 62 of file Handle.h.

Constructor & Destructor Documentation

Sender() [1/2]

qpid::messaging::Sender::Sender

(

SenderImpl *

impl = 0

)

Sender() [2/2]

qpid::messaging::Sender::Sender

(

const Sender &

)

~Sender()

qpid::messaging::Sender::~Sender

(

)

Member Function Documentation

close()

void qpid::messaging::Sender::close

(

)

getAddress()

Address qpid::messaging::Sender::getAddress

(

)

const

Returns an address for this sender.

getAvailable()

uint32_t qpid::messaging::Sender::getAvailable

(

)

Returns the number of messages for which there is available capacity.

getCapacity()

uint32_t qpid::messaging::Sender::getCapacity

(

)

Returns the capacity of the sender.

See also

setCapacity

getName()

const std::string& qpid::messaging::Sender::getName

(

)

const

Returns the name of this sender.

getSession()

Session qpid::messaging::Sender::getSession

(

)

const

Returns a handle to the session associated with this sender.

getUnsettled()

uint32_t qpid::messaging::Sender::getUnsettled

(

)

Returns the number of sent messages pending confirmation of receipt by the broker.

(These are the 'in-doubt' messages).

isNull()

QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< SenderImpl >::isNull ( ) const

inlineinherited

Returns

true if handle is null. It is an error to call any function on a null handle.

Definition at line 46 of file Handle.h.

isValid()

QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< SenderImpl >::isValid ( ) const

inlineinherited

Returns

true if handle is valid, i.e. not null.

Definition at line 43 of file Handle.h.

operator bool()

QPID_MESSAGING_INLINE_EXTERN qpid::messaging::Handle< SenderImpl >::operator bool ( ) const

inlineinherited

Conversion to bool supports idiom if (handle) { handle->...

}

Definition at line 49 of file Handle.h.

operator!()

QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< SenderImpl >::operator! ( ) const

inlineinherited

Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.

Definition at line 52 of file Handle.h.

operator=()

Sender& qpid::messaging::Sender::operator=

(

const Sender &

)

send()

void qpid::messaging::Sender::send	(	const Message &	message,
		bool	sync = false
	)

Sends a message.

Parameters

message	the message to send
sync	if true the call will block until the server confirms receipt of the messages; if false will only block for available capacity (i.e. pending == capacity)

setCapacity()

void qpid::messaging::Sender::setCapacity

(

uint32_t

)

Sets the capacity for the sender.

The capacity determines how many outgoing messages can be held pending confirmation of receipt by the broker.

swap()

void qpid::messaging::Handle< SenderImpl >::swap ( Handle< SenderImpl > &  h )

inlineinherited

Definition at line 54 of file Handle.h.

Member Data Documentation

impl

Impl* qpid::messaging::Handle< SenderImpl >::impl

protectedinherited

Definition at line 65 of file Handle.h.

---

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

• qpid/messaging/Sender.h