Qpid Proton C++ API  0.17.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
link Class Reference

A named channel for sending or receiving messages. More...

#include <link.hpp>

Inheritance diagram for link:
endpoint receiver sender

Public Member Functions

 link ()
 Create an empty link.
 
bool uninitialized () const
 True if the local end is uninitialized.
 
bool active () const
 True if the local end is active.
 
bool closed () const
 True if the local and remote ends are closed.
 
class error_condition error () const
 Get the error condition of the remote endpoint.
 
void close ()
 Close the endpoint. More...
 
void close (const error_condition &)
 Close the endpoint with an error condition. More...
 
void detach ()
 Suspend the link without closing it. More...
 
int credit () const
 Credit available on the link.
 
bool draining ()
 Experimental - True for a receiver if a drain cycle has been started and the corresponding on_receiver_drain_finish event is still pending. More...
 
std::string name () const
 Get the link name.
 
class containercontainer () const
 The container for this link.
 
class connection connection () const
 The connection that owns this link.
 
class session session () const
 The session that owns this link.
 

Detailed Description

A named channel for sending or receiving messages.

It is the base class for sender and receiver.

Member Function Documentation

void close ( )
virtual

Close the endpoint.

See Also
endpoint_lifecycle

Implements endpoint.

Examples:
direct_recv.cpp, helloworld.cpp, helloworld_direct.cpp, and simple_recv.cpp.
void close ( const error_condition )
virtual

Close the endpoint with an error condition.

See Also
endpoint_lifecycle

Implements endpoint.

void detach ( )

Suspend the link without closing it.

A suspended link may be reopened with the same or different link options if supported by the peer. A suspended durable subscription becomes inactive without cancelling it.

bool draining ( )

Experimental - True for a receiver if a drain cycle has been started and the corresponding on_receiver_drain_finish event is still pending.

True for a sender if the receiver has requested a drain of credit and the sender has unused credit.

See Also
receiver::drain.

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