Struct IoRef

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

Implementations

impl IoRef

pub fn memory_pool(&self) -> PoolRef

Get memory pool

pub fn is_closed(&self) -> bool

Check if io stream is closed

pub fn is_wr_backpressure(&self) -> bool

Check if write back-pressure is enabled

pub fn wake(&self)

Wake dispatcher task

pub fn close(&self)

Gracefully close connection

Notify dispatcher and initiate io stream shutdown process.

pub fn force_close(&self)

Force close connection

Dispatcher does not wait for uncompleted responses. Io stream get terminated without any graceful period.

pub fn want_shutdown(&self)

Gracefully shutdown io stream

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

Query filter specific data

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

where U: Encoder,

Encode and write item to a buffer and wake up write task

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 write(&self, src: &[u8]) -> Result<()>

Write bytes to a buffer and wake up write task

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

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

Get access to write buffer

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

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

Get mut access to source write buffer

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

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

Get mut access to source read buffer

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 tag(&self) -> &'static str

Get tag

pub fn set_tag(&self, tag: &'static str)

Set tag

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 copy 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 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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for IoRef