Struct lapin_async::connection::Connection

pub struct Connection {
    pub status: ConnectionStatus,
    pub channels: Channels,
    pub configuration: Configuration,
    // some fields omitted
}

Fields

status: ConnectionStatus

current state of the connection. In normal use it should always be ConnectionState::Connected

channels: Channels

configuration: Configuration

Methods

impl Connection

pub fn new() -> Self

creates a Connection object in initial state

pub fn create_channel(&self) -> Result<Channel, Error>

pub fn connect(
    &self,
    credentials: Credentials,
    options: ConnectionProperties
) -> Result<ConnectionState, Error>

starts the process of connecting to the server

this will set up the state machine and generates the required messages. The messages will not be sent until calls to serialize to write the messages to a buffer, or calls to next_frame to obtain the next message to send

pub fn send_frame(&self, frame: AMQPFrame)

pub fn next_frame(&self) -> Option<AMQPFrame>

next message to send to the network

returns None if there's no message to send

pub fn serialize(
    &self,
    send_buffer: &mut [u8]
) -> Result<(usize, ConnectionState), Error>

writes the next message to a mutable byte slice

returns how many bytes were written and the current state. this method can be called repeatedly until the buffer is full or there are no more frames to send

pub fn parse(&self, data: &[u8]) -> Result<(usize, ConnectionState), Error>

parses a frame from a byte slice

returns how many bytes were consumed and the current state.

This method will update the state machine according to the ReceivedStart frame with handle_frame

pub fn handle_frame(&self, f: AMQPFrame) -> Result<(), Error>

updates the current state with a new received frame

pub fn set_closing(&self)

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

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

impl Connection

pub fn run<T: Read + Write>(
    &mut self,
    stream: &mut T,
    send_buffer: &mut Buffer,
    receive_buffer: &mut Buffer
) -> Result<ConnectionState, Error>

helper function to handle reading and writing repeatedly from the network until there's no more state to update

Trait Implementations

impl Default for Connection

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.