Struct IoRef 

pub struct IoRef(/* private fields */);

Cloneable reference to an Io connection’s shared state.

Implementations

impl IoRef

pub fn id(&self) -> Id

Gets the ID.

pub fn tag(&self) -> &'static str

Gets the I/O tag.

pub fn cfg(&self) -> &IoConfig

Gets the configuration.

pub fn shared(&self) -> SharedCfg

Gets the shared configuration.

pub fn is_closed(&self) -> bool

Checks whether the I/O stream is closed.

pub fn is_wr_backpressure(&self) -> bool

Checks whether write back-pressure is enabled.

pub fn close(&self)

Gracefully closes the connection.

Initiates the I/O stream shutdown process.

pub fn terminate(&self)

Force-closes the connection.

The dispatcher does not wait for incomplete responses. The I/O stream is terminated without any graceful period.

pub fn query<T: 'static>(&self) -> QueryItem<T>

Queries filter-specific data.

pub fn encode<U>( &self, item: U::Item, codec: &U, ) -> Result<(), <U as Encoder>::Error>

where U: Encoder,

Encodes the item into the write buffer.

pub fn encode_slice(&self, src: &[u8]) -> Result<()>

Encodes the slice into the write buffer.

pub fn encode_bytes<B>(&self, src: B) -> Result<()>

where BytePage: From<B>,

Writes bytes to the write buffer.

pub fn decode<U>( &self, codec: &U, ) -> Result<Option<<U as Decoder>::Item>, <U as Decoder>::Error>

where U: Decoder,

Attempts to decode a frame from the read buffer.

pub fn decode_item<U>( &self, codec: &U, ) -> Result<Decoded<<U as Decoder>::Item>, <U as Decoder>::Error>

where U: Decoder,

Attempts to decode a frame from the read buffer.

pub fn send_buf(&self) -> Result<()>

Sends the write buffer to the I/O layer.

Requires the underlying runtime to implement .write(); otherwise, no action is taken.

pub fn with_buf<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&mut FilterBuf<'_>) -> R,

Get access to filter buffer

pub fn with_read_buf<F, R>(&self, f: F) -> R

where F: FnOnce(&mut BytesMut) -> R,

Get mut access to read buffer

pub fn with_write_buf<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&mut BytePages) -> R,

Get mut access to source write buffer

pub fn with_read_src_buf<F, R>(&self, f: F) -> R

where F: FnOnce(&mut BytesMut) -> R,

Get mut access to src read buffer

pub fn with_write_dst_buf<F, R>(&self, f: F) -> R

where F: FnOnce(&mut BytePages) -> R,

Get mut access to dest write buffer

pub fn resize_read_buf(&self, buf: &mut BytesMut)

Make sure buffer has enough free space

pub fn notify_dispatcher(&self)

Wakeup dispatcher

pub fn notify_timeout(&self)

Wakeup dispatcher and send keep-alive error

pub fn timer_handle(&self) -> TimerHandle

Current timer handle

pub fn start_timer(&self, timeout: Seconds) -> TimerHandle

Start timer

pub fn stop_timer(&self)

Stop timer

pub fn on_disconnect(&self) -> OnDisconnect

Notify when io stream get disconnected

Trait Implementations

impl<F> AsRef<IoRef> for Io<F>

fn as_ref(&self) -> &IoRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IoRef

fn clone(&self) -> IoRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IoRef

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

Formats the value using the given formatter.

impl Eq for IoRef

impl Hash for IoRef

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for IoRef

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.