Struct Connection 

pub struct Connection { /* private fields */ }

Type represents an connection.

See documentation of each method. See also documentation of module .

Implementations

impl Connection

pub async fn open(args: &OpenConnectionArguments) -> Result<Connection, Error>

Open and returns a new connection.

Errors

Returns Err if any step goes wrong during openning an connection.

pub fn connection_name(&self) -> &str

Get connection name.

pub fn channel_max(&self) -> u16

Get the maximum total number of channels of the connection.

pub fn frame_max(&self) -> u32

Get The largest frame size that the client and server will use for the connection.

pub fn server_properties(&self) -> &ServerProperties

Get the server propertities reported by server.

pub async fn register_callback<F>(&self, callback: F) -> Result<(), Error>

where F: ConnectionCallback + Send + 'static,

Register callbacks for handling asynchronous message from server for the connection.

User should always register callbacks. See callbacks documentation.

Errors

Returns error if fail to send registration command. If returns Err, user can try again until registration succeed.

pub fn is_open(&self) -> bool

Returns true if connection is open.

pub fn heartbeat(&self) -> u16

Returns interval of heartbeat in seconds.

pub async fn open_channel( &self, channel_id: Option<u16>, ) -> Result<Channel, Error>

Open and return a new AMQP channel.

channel_id range: 1 to 65535.

Automatically generate an id if input channel_id = None, otherwise, use the given input id.

Errors

Returns error if the given channel_id is occupied, or any failure in resource allocation and communication with server.

pub async fn blocked(&self, reason: &str) -> Result<(), Error>

This method notify server that the connection has been blocked and does not accept new publishes.

Errors

Returns error if fails to send indication to server.

pub async fn unblocked(&self) -> Result<(), Error>

This method notify server that the connection has been unblocked and does not accept new publishes.

Errors

Returns error if fails to send indication to server.

pub async fn close(self) -> Result<(), Error>

Send request to server to close the connection.

To gracefully shutdown the connection, recommended to close the connection explicitly instead of relying on drop.

This method consume the connection, so even it may return error, connection will anyway be dropped.

Errors

Returns error if any failure in communication with server.

pub async fn listen_network_io_failure(&self) -> bool

Wait until the underlying network I/O failure occurs.

It will block the current async task. To handle it asynchronously, use tokio::spawn to run it in a seperate task.

Returns

Return true if got notification due to network I/O failure, otherwise return false.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for Connection

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.