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

qpid::messaging::Sender Class Reference

Interface through which messages are sent. More...

#include <qpid/messaging/Sender.h>

List of all members.

Public Member Functions

 Sender (SenderImpl *impl=0)
 Sender (const Sender &)
 ~Sender ()
Senderoperator= (const Sender &)
void send (const Message &message)
void cancel ()
void setCapacity (uint32_t)
 Sets the capacity for the sender.
uint32_t getCapacity ()
 Returns the capacity of the sender.
uint32_t pending ()
 Returns the number of sent messages pending confirmation of receipt by the broker.
const std::string & getName () const
 Returns the name of this sender.
Session getSession () const
 Returns a handle to the session associated with this sender.
bool isValid () const
bool isNull () const
 operator bool () const
 Conversion to bool supports idiom if (handle) { handle->.
bool operator! () const
 Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
void swap (Handle< SenderImpl > &h)

Protected Types

typedef SenderImpl Impl

Protected Attributes

Implimpl

Detailed Description

Interface through which messages are sent.

Definition at line 44 of file Sender.h.


Member Typedef Documentation

typedef SenderImpl qpid::client::Handle< SenderImpl >::Impl [protected, inherited]

Definition at line 57 of file Handle.h.


Constructor & Destructor Documentation

qpid::messaging::Sender::Sender ( SenderImpl *  impl = 0  ) 
qpid::messaging::Sender::Sender ( const Sender  ) 
qpid::messaging::Sender::~Sender (  ) 

Member Function Documentation

void qpid::messaging::Sender::cancel (  ) 
uint32_t qpid::messaging::Sender::getCapacity (  ) 

Returns the capacity of the sender.

See also:
setCapacity
const std::string& qpid::messaging::Sender::getName (  )  const

Returns the name of this sender.

Session qpid::messaging::Sender::getSession (  )  const

Returns a handle to the session associated with this sender.

bool qpid::client::Handle< SenderImpl >::isNull (  )  const [inline, inherited]
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.

bool qpid::client::Handle< SenderImpl >::isValid (  )  const [inline, inherited]
Returns:
true if handle is valid, i.e. not null.

Definition at line 43 of file Handle.h.

qpid::client::Handle< SenderImpl >::operator bool (  )  const [inline, inherited]

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

.. }

Definition at line 49 of file Handle.h.

bool qpid::client::Handle< SenderImpl >::operator! (  )  const [inline, inherited]

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

Definition at line 52 of file Handle.h.

Sender& qpid::messaging::Sender::operator= ( const Sender  ) 
uint32_t qpid::messaging::Sender::pending (  ) 

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

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

void qpid::messaging::Sender::send ( const Message message  ) 
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.

void qpid::client::Handle< SenderImpl >::swap ( Handle< SenderImpl > &  h  )  [inline, inherited]

Definition at line 54 of file Handle.h.


Member Data Documentation

Impl* qpid::client::Handle< SenderImpl >::impl [protected, inherited]

Definition at line 64 of file Handle.h.


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

Qpid C++ API Reference
Generated on Tue May 4 14:28:25 2010 for Qpid C++ Client API by doxygen 1.6.2-20100208