Qpid Proton C++  0.12.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
sender Class Reference

A link for sending messages. More...

#include <sender.hpp>

Inheritance diagram for sender:
link endpoint

Public Types

typedef int state
 A bit mask of state bit values. More...
 

Public Member Functions

delivery send (const message &m)
 Send a message on the link.
 
endpoint::state state () const
 Get the state of this link.
 
condition local_condition () const
 Get the local error condition.
 
condition remote_condition () const
 Get the error condition of the remote endpoint.
 
void open (const link_options &opts=link_options())
 Locally open the link. More...
 
void close ()
 Locally close the link. More...
 
class sender sender ()
 Return sender if this link is a sender, 0 if not.
 
class sender sender () const
 Return sender if this link is a sender, 0 if not.
 
class receiver receiver ()
 Return receiver if this link is a receiver, 0 if not.
 
class receiver receiver () const
 Return receiver if this link is a receiver, 0 if not.
 
int credit () const
 Credit available on the link.
 
int queued ()
 The number of deliveries queued on the link.
 
terminus local_source () const
 Local source of the link.
 
terminus local_target () const
 Local target of the link.
 
terminus remote_source () const
 Remote source of the link.
 
terminus remote_target () const
 Remote target of the link.
 
std::string name () const
 Get the link name.
 
class connection connection () const
 Connection that owns this link.
 
class session session () const
 Session that owns this link.
 

Static Public Attributes

static const state LOCAL_UNINIT
 Local endpoint is uninitialized.
 
static const state REMOTE_UNINIT
 Remote endpoint is uninitialized.
 
static const state LOCAL_ACTIVE
 Local endpoint is active.
 
static const state REMOTE_ACTIVE
 Remote endpoint is active.
 
static const state LOCAL_CLOSED
 Local endpoint has been closed.
 
static const state REMOTE_CLOSED
 Remote endpoint has been closed.
 
static const state LOCAL_MASK
 Mask including all LOCAL_ bits (UNINIT, ACTIVE, CLOSED)
 
static const state REMOTE_MASK
 Mask including all REMOTE_ bits (UNINIT, ACTIVE, CLOSED)
 

Detailed Description

A link for sending messages.

Examples:
broker.hpp, client.cpp, direct_send.cpp, engine/client.cpp, engine/direct_send.cpp, engine/simple_send.cpp, server_direct.cpp, and simple_send.cpp.

Member Typedef Documentation

typedef int state
inherited

A bit mask of state bit values.

A state mask is matched against an endpoint as follows: If the state mask contains both local and remote flags, then an exact match against those flags is performed. If state contains only local or only remote flags, then a match occurs if any of the local or remote flags are set respectively.

See Also
connection::find_links, connection::find_sessions

Member Function Documentation

void close ( )
inherited
void open ( const link_options opts = link_options())
inherited

Locally open the link.

The operation is not complete till handler::on_link_open.


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