Struct ProtocolContext

pub struct ProtocolContext {
    pub proto_id: ProtocolId,
    /* private fields */
}

Protocol handle context

Fields

proto_id: ProtocolId

Protocol id

Methods from Deref<Target = ServiceContext>

pub async fn listen(&self, address: Multiaddr) -> Result<(), SendErrorKind>

Create a new listener

pub async fn dial( &self, address: Multiaddr, target: TargetProtocol, ) -> Result<(), SendErrorKind>

Initiate a connection request to address

pub async fn disconnect( &self, session_id: SessionId, ) -> Result<(), SendErrorKind>

Disconnect a connection

pub async fn send_message_to( &self, session_id: SessionId, proto_id: ProtocolId, data: Bytes, ) -> Result<(), SendErrorKind>

Send message

pub async fn quick_send_message_to( &self, session_id: SessionId, proto_id: ProtocolId, data: Bytes, ) -> Result<(), SendErrorKind>

Send message on quick channel

pub async fn filter_broadcast( &self, session_ids: TargetSession, proto_id: ProtocolId, data: Bytes, ) -> Result<(), SendErrorKind>

Send data to the specified protocol for the specified sessions.

pub async fn quick_filter_broadcast( &self, session_ids: TargetSession, proto_id: ProtocolId, data: Bytes, ) -> Result<(), SendErrorKind>

Send data to the specified protocol for the specified sessions on quick channel.

pub async fn future_task<T>(&self, task: T) -> Result<(), SendErrorKind>

where T: Future<Output = ()> + 'static + Send,

Send a future task

pub async fn open_protocol( &self, session_id: SessionId, proto_id: ProtocolId, ) -> Result<(), SendErrorKind>

Try open a protocol

If the protocol has been open, do nothing

pub async fn open_protocols( &self, session_id: SessionId, target: TargetProtocol, ) -> Result<(), SendErrorKind>

Try open protocol

If the protocol has been open, do nothing

pub async fn close_protocol( &self, session_id: SessionId, proto_id: ProtocolId, ) -> Result<(), SendErrorKind>

Try close a protocol

If the protocol has been closed, do nothing

pub fn control(&self) -> &ServiceAsyncControl

Get the internal channel sender side handle

pub fn listens(&self) -> &[Multiaddr]

Get service listen address list

pub async fn set_service_notify( &self, proto_id: ProtocolId, interval: Duration, token: u64, ) -> Result<(), SendErrorKind>

Set a service notify token

pub async fn set_session_notify( &self, session_id: SessionId, proto_id: ProtocolId, interval: Duration, token: u64, ) -> Result<(), SendErrorKind>

Set a session notify token

pub async fn remove_service_notify( &self, proto_id: ProtocolId, token: u64, ) -> Result<(), SendErrorKind>

Remove a service timer by a token

pub async fn remove_session_notify( &self, session_id: SessionId, proto_id: ProtocolId, token: u64, ) -> Result<(), SendErrorKind>

Remove a session timer by a token

pub async fn close(&self) -> Result<(), SendErrorKind>

Close service.

Order:

1. close all listens
2. try close all session’s protocol stream
3. try close all session
4. close service

pub async fn shutdown(&self) -> Result<(), SendErrorKind>

Shutdown service, don’t care anything, may cause partial message loss

Trait Implementations

impl Deref for ProtocolContext

type Target = ServiceContext

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ProtocolContext

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.