Qpid C++ Messaging API  0.22
qpid::messaging::Sender Class Reference

#include <Sender.h>

Inheritance diagram for qpid::messaging::Sender:
Collaboration diagram for qpid::messaging::Sender:

List of all members.

Public Member Functions

QPID_MESSAGING_EXTERN Sender (SenderImpl *impl=0)
QPID_MESSAGING_EXTERN Sender (const Sender &)
QPID_MESSAGING_EXTERN Senderoperator= (const Sender &)
QPID_MESSAGING_EXTERN void send (const Message &message, bool sync=false)
QPID_MESSAGING_EXTERN void setCapacity (uint32_t)
QPID_MESSAGING_EXTERN uint32_t getCapacity ()
QPID_MESSAGING_EXTERN uint32_t getUnsettled ()
QPID_MESSAGING_EXTERN uint32_t getAvailable ()
std::string & 
getName () const
QPID_MESSAGING_EXTERN Session getSession () const
QPID_MESSAGING_EXTERN Address getAddress () const


class qpid::messaging::PrivateImplRef< Sender >

Detailed Description

Interface through which messages are sent.

Constructor & Destructor Documentation

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

Member Function Documentation

QPID_MESSAGING_EXTERN void qpid::messaging::Sender::close ( )
QPID_MESSAGING_EXTERN Address qpid::messaging::Sender::getAddress ( ) const

Returns an address for this sender.

QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Sender::getAvailable ( )

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

QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Sender::getCapacity ( )

Returns the capacity of the sender.

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

Returns the name of this sender.

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

Returns a handle to the session associated with this sender.

QPID_MESSAGING_EXTERN 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).

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

Sends a message

messagethe message to send
syncif 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)
QPID_MESSAGING_EXTERN 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.

Friends And Related Function Documentation

friend class qpid::messaging::PrivateImplRef< Sender > [friend]

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