Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
#include <qpid/messaging/Sender.h>
Inherits qpid::messaging::Handle< SenderImpl >.
Public Member Functions | |
QPID_MESSAGING_EXTERN | Sender (SenderImpl *impl=0) |
QPID_MESSAGING_EXTERN | Sender (const Sender &) |
QPID_MESSAGING_EXTERN | ~Sender () |
QPID_MESSAGING_EXTERN Sender & | operator= (const Sender &) |
QPID_MESSAGING_EXTERN void | send (const Message &message, bool sync=false) |
Sends a message. | |
QPID_MESSAGING_EXTERN void | close () |
QPID_MESSAGING_EXTERN void | setCapacity (uint32_t) |
Sets the capacity for the sender. | |
QPID_MESSAGING_EXTERN uint32_t | getCapacity () |
Returns the capacity of the sender. | |
QPID_MESSAGING_EXTERN uint32_t | getUnsettled () |
Returns the number of sent messages pending confirmation of receipt by the broker. | |
QPID_MESSAGING_EXTERN uint32_t | getAvailable () |
Returns the number of messages for which there is available capacity. | |
QPID_MESSAGING_EXTERN const std::string & | getName () const |
Returns the name of this sender. | |
QPID_MESSAGING_EXTERN Session | getSession () const |
Returns a handle to the session associated with this sender. | |
QPID_MESSAGING_EXTERN bool | isValid () const |
QPID_MESSAGING_EXTERN bool | isNull () const |
QPID_MESSAGING_EXTERN | operator bool () const |
Conversion to bool supports idiom if (handle) { handle->. | |
QPID_MESSAGING_EXTERN 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 | |
Impl * | impl |
Definition at line 41 of file Sender.h.
typedef SenderImpl qpid::messaging::Handle< SenderImpl >::Impl [protected, inherited] |
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 | ( | ) |
QPID_MESSAGING_EXTERN void qpid::messaging::Sender::close | ( | ) |
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 | ( | ) |
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 bool qpid::messaging::Handle< SenderImpl >::isNull | ( | ) | const [inline, inherited] |
QPID_MESSAGING_EXTERN bool qpid::messaging::Handle< SenderImpl >::isValid | ( | ) | const [inline, inherited] |
QPID_MESSAGING_EXTERN qpid::messaging::Handle< SenderImpl >::operator bool | ( | ) | const [inline, inherited] |
QPID_MESSAGING_EXTERN bool qpid::messaging::Handle< SenderImpl >::operator! | ( | ) | const [inline, inherited] |
QPID_MESSAGING_EXTERN void qpid::messaging::Sender::send | ( | const Message & | message, | |
bool | sync = false | |||
) |
Sends a message.
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) |
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.
void qpid::messaging::Handle< SenderImpl >::swap | ( | Handle< SenderImpl > & | h | ) | [inline, inherited] |
Impl* qpid::messaging::Handle< SenderImpl >::impl [protected, inherited] |