Struct links_nonblocking::connect::clt::CltSender

pub struct CltSender<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> { /* private fields */ }

An abstraction over a MessageSender that executes crate::prelude::ProtocolCore::on_send, crate::prelude::ProtocolCore::on_sent/crate::prelude::ProtocolCore::on_wouldblock/crate::prelude::ProtocolCore::on_error and CallbackSend::on_sent on every message processed by CltSender. It is designed to work in a single thread that is different from CltRecver thread

Important

This is an owned implementation and is not Cloneable.

Warning

Dropping CltSender will also result in termination of the connection in the paired CltRecver instance

Implementations

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> CltSender<P, C, MAX_MSG_SIZE>

pub fn new( sender: MessageSender<P, MAX_MSG_SIZE>, callback: Arc<C>, protocol: Arc<P>, acceptor_connection_gate: Option<RemoveConnectionBarrierOnDrop> ) -> Self

Trait Implementations

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> ConnectionId for CltSender<P, C, MAX_MSG_SIZE>

fn con_id(&self) -> &ConId

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> ConnectionStatus for CltSender<P, C, MAX_MSG_SIZE>

fn is_connected(&self) -> bool

logical check of connection status

fn is_connected_busywait_timeout(&self, timeout: Duration) -> bool

impl<P: Debug + Protocol, C: Debug + CallbackSend<P>, const MAX_MSG_SIZE: usize> Debug for CltSender<P, C, MAX_MSG_SIZE>

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

Formats the value using the given formatter.

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> Display for CltSender<P, C, MAX_MSG_SIZE>

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

Formats the value using the given formatter.

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> Drop for CltSender<P, C, MAX_MSG_SIZE>

fn drop(&mut self)

Executes the destructor for this type.

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> ReSendNonBlocking<<P as Messenger>::SendT> for CltSender<P, C, MAX_MSG_SIZE>

fn re_send(&mut self, msg: &P::SendT) -> Result<SendStatus, Error>

The call will internally serialize the msg and attempt to write the resulting bytes into a stream. If there was a successfull attempt which wrote some bytes from serialized message into the stream but the write was only partial then the call will busy wait until all of remaining bytes were written before returning SendStatus::Completed. SendStatus::WouldBlock is returned only if the attempt did not write any bytes to the stream after the first attempt

fn re_send_busywait_timeout( &mut self, msg: &T, timeout: Duration ) -> Result<SendStatus, Error>

Will call Self::re_send until it returns SendStatus::Completed or SendStatus::WouldBlock after the timeout,

fn re_send_busywait(&mut self, msg: &T) -> Result<(), Error>

Will call Self::re_send until it returns SendStatus::Completed

impl<P: Protocol, C: CallbackSend<P>, const MAX_MSG_SIZE: usize> SendNonBlocking<<P as Messenger>::SendT> for CltSender<P, C, MAX_MSG_SIZE>

fn send( &mut self, msg: &mut <P as Messenger>::SendT ) -> Result<SendStatus, Error>

The call will internally serialize the T and attempt to write the resulting bytes into a stream. If there was a successfull attempt which wrote some, not all, bytes from serialized message into the stream and hence the write was only partial, the call will busy wait until all of remaining bytes are written before returning SendStatus::Completed. SendStatus::WouldBlock is returned only if the attempt did not write any bytes to the stream after the first attempt

fn send_busywait_timeout( &mut self, msg: &mut <P as Messenger>::SendT, timeout: Duration ) -> Result<SendStatus, Error>

Will call Self::send until it returns SendStatus::Completed or SendStatus::WouldBlock after the timeout, while propagating all errors from Self::send

fn send_busywait( &mut self, msg: &mut <P as Messenger>::SendT ) -> Result<(), Error>

Will call Self::send until it returns SendStatus::Completed