Struct aldrin_broker::Connection

pub struct Connection<T>
where
    T: AsyncTransport + Unpin,
{ /* private fields */ }

Connection between a broker and a client.

Connections can be established with BrokerHandle::connect and must then be run and polled to completion.

You can optionally acquire a ConnectionHandle if you need to be able to shut down specific Connections.

Implementations

impl<T> Connection<T>

where T: AsyncTransport + Unpin,

pub fn handle(&self) -> &ConnectionHandle

Returns a reference to the connection handle.

ConnectionHandles can be used to shut down a specific Connection.

Note also, that this method returns only a reference. However, ConnectionHandles are cheap to clone.

pub async fn run(self) -> Result<(), ConnectionError<T::Error>>

Runs the connections.

After establishing a new Connection, this method must be called and polled to completion to run the Connection.

Trait Implementations

impl<T> Debug for Connection<T>

where T: AsyncTransport + Unpin + Debug,

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

Formats the value using the given formatter.