Struct ckb_network::ServiceControl

source · [−]

pub struct ServiceControl { /* private fields */ }

Expand description

Service control, used to send commands externally at runtime

Implementations

source

impl ServiceControl

source

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

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

source

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

Create a new listener

source

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

Initiate a connection request to address

source

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

Disconnect a connection

source

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

Send message

source

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

Send message on quick channel

source

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

Send data to the specified protocol for the specified sessions.

source

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.

source

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

Send a future task

source

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

source

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

Try open protocol

If the protocol has been open, do nothing

source

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

source

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

Set a service notify token

source

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

remove a service notify token

source

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

Set a session notify token

source

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

Remove a session notify token

source

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

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

Trait Implementations

source

impl Clone for ServiceControl

source

fn clone(&self) -> ServiceControl

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl From<ServiceAsyncControl> for ServiceControl

source

fn from(control: ServiceAsyncControl) -> ServiceControl

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for ServiceControl

impl Send for ServiceControl

impl Sync for ServiceControl

impl Unpin for ServiceControl

impl !UnwindSafe for ServiceControl

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

impl<T> AsAny for T where
T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

TODO(doc): @quake

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, 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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.

Struct ckb_network::ServiceControl

Implementations

impl ServiceControl

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for ServiceControl

fn clone(&self) -> ServiceControl

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

impl From<ServiceAsyncControl> for ServiceControl

fn from(control: ServiceAsyncControl) -> ServiceControl

Auto Trait Implementations

impl !RefUnwindSafe for ServiceControl

impl Send for ServiceControl

impl Sync for ServiceControl

impl Unpin for ServiceControl

impl !UnwindSafe for ServiceControl

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

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, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut 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

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

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

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

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

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

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

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

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

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

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

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

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

pub 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> AsAny for T where
T: Any,

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> ToOwned for T where
T: Clone,

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