Struct tentacle::context::ServiceContext

source · [−]

pub struct ServiceContext { /* private fields */ }

Expand description

The Service runtime can send some instructions to the inside of the handle. This is the sending channel.

Implementations

source

impl ServiceContext

source

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

Create a new listener

source

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

Initiate a connection request to address

source

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

Disconnect a connection

source

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

Send message

source

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

Send message on quick channel

source

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.

source

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.

source

pub async fn future_task<T>(&self, task: T) -> Result<(), SendErrorKind> where
T: Future<Output = ()> + 'static + Send,

Send a future task

source

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

source

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

Try open protocol

If the protocol has been open, do nothing

source

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

source

pub fn control(&self) -> &ServiceAsyncControl

Get the internal channel sender side handle

source

pub fn protocols(&self) -> &Arc<HashMap<ProtocolId, ProtocolInfo>>

Get service protocol message, Map(ID, Name), but can’t modify

source

pub fn key_pair(&self) -> Option<&SecioKeyPair>

Get the key pair of self

source

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

Get service listen address list

source

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

Set a service notify token

source

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

Set a session notify token

source

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

Remove a service timer by a token

source

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

Remove a session timer by a token

source

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

Close service.

Order:

close all listens
try close all session’s protocol stream
try close all session
close service

source

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

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

Auto Trait Implementations

impl !RefUnwindSafe for ServiceContext

impl Send for ServiceContext

impl Sync for ServiceContext

impl Unpin for ServiceContext

impl !UnwindSafe for ServiceContext

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct tentacle::context::ServiceContext

Implementations

impl ServiceContext

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

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

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

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

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

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

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

pub async fn future_task<T>(&self, task: T) -> Result<(), SendErrorKind> where T: Future<Output = ()> + 'static + Send,

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

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

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

pub fn control(&self) -> &ServiceAsyncControl

pub fn protocols(&self) -> &Arc<HashMap<ProtocolId, ProtocolInfo>>

pub fn key_pair(&self) -> Option<&SecioKeyPair>

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

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

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

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

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

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

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

Auto Trait Implementations

impl !RefUnwindSafe for ServiceContext

impl Send for ServiceContext

impl Sync for ServiceContext

impl Unpin for ServiceContext

impl !UnwindSafe for ServiceContext

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

pub async fn future_task<T>(&self, task: T) -> Result<(), SendErrorKind> where
T: Future<Output = ()> + 'static + Send,

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,