Struct remoc::chmux::Sender

pub struct Sender { /* private fields */ }

Sends byte data over a channel.

Implementations

impl Sender

pub fn local_port(&self) -> u32

The local port number.

pub fn remote_port(&self) -> u32

The remote port number.

pub fn chunk_size(&self) -> usize

Maximum chunk size that can be sent.

This is set by the remote endpoint.

pub fn max_data_size(&self) -> usize

Configured maximum data size of receiver.

This is not a limit for the sender and only provided here for advisory purposes.

pub async fn send(&mut self, data: Bytes) -> Result<(), SendError>

Sends data over the channel.

Waits until send space becomes available. Data is transmitted in chunks if it exceeds the maximum chunk size.

Cancel safety

If this function is cancelled before completion, the remote endpoint will receive no data.

pub fn send_chunks(&mut self) -> ChunkSender<'_>

Streams a message by sending individual chunks.

pub fn try_send(&mut self, data: &Bytes) -> Result<(), TrySendError>

Tries to send data over the channel.

Does not wait until send space becomes available. The maximum size of data sendable by this function is limited by the total receive buffer size.

pub async fn connect( &mut self, ports: Vec<PortReq>, wait: bool ) -> Result<Vec<Connect>, SendError>

Sends port open requests over this port and returns the connect requests.

The receiver limits the number of ports sendable per call, see Receiver::max_ports.

pub fn is_closed(&self) -> bool

True, once the remote endpoint has closed its receiver.

pub fn closed(&self) -> Closed

Returns a future that will resolve when the remote endpoint closes its receiver.

pub fn is_graceful_close_overridden(&self) -> bool

Returns whether data can be sent anyway, even if remote endpoint closed the channel gracefully.

Sending always fails if remote endpoint closed the channel non-gracefully, for example by dropping the receiver.

By default this is false.

pub fn set_override_graceful_close(&mut self, override_graceful_close: bool)

Sets whether data should be sent anyway, even if remote endpoint closed the channel gracefully.

Sending always fails if remote endpoint closed the channel non-gracefully, for example by dropping the receiver.

pub fn into_sink(self) -> SenderSink

Convert this into a sink.

pub fn port_allocator(&self) -> PortAllocator

Returns the port allocator of the channel multiplexer.

pub fn storage(&self) -> AnyStorage

Returns the arbitrary data storage of the channel multiplexer.

Trait Implementations

impl Debug for Sender

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

Formats the value using the given formatter.

impl Drop for Sender

fn drop(&mut self)

Executes the destructor for this type.