Struct tentacle::service::ServiceControl

pub struct ServiceControl { /* fields omitted */ }

Service control, used to send commands externally at runtime

Implementations

impl ServiceControl

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

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

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

Create a new listener

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

Initiate a connection request to address

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

Disconnect a connection

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

Send message

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

Send message on quick channel

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

Send data to the specified protocol for the specified sessions.

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

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

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

Send a future task

pub 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 fn open_protocols(
    &self,
    session_id: SessionId,
    target: TargetProtocol
) -> Result<(), SendErrorKind>

Try open protocol

If the protocol has been open, do nothing

pub 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 set_service_notify(
    &self,
    proto_id: ProtocolId,
    interval: Duration,
    token: u64
) -> Result<(), SendErrorKind>

Set a service notify token

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

remove a service notify token

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

Set a session notify token

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

Remove a session notify token

pub 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 fn shutdown(&self) -> Result<(), SendErrorKind>

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

Trait Implementations

impl Clone for ServiceControl

fn clone(&self) -> ServiceControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<ServiceAsyncControl> for ServiceControl

fn from(control: ServiceAsyncControl) -> Self

Performs the conversion.

impl From<ServiceControl> for ServiceAsyncControl

fn from(control: ServiceControl) -> Self

Performs the conversion.