Trait ckb_network::ServiceProtocol

source · [−]
pub trait ServiceProtocol: Send {
    fn init<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        context: &'life1 mut ProtocolContext
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;

    fn connected<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 mut self,
        _context: ProtocolContextMutRef<'life1>,
        _version: &'life2 str
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        'life2: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn disconnected<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        _context: ProtocolContextMutRef<'life1>
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn received<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        _context: ProtocolContextMutRef<'life1>,
        _data: Bytes
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn notify<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        _context: &'life1 mut ProtocolContext,
        _token: u64
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn poll<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        _context: &'life1 mut ProtocolContext
    ) -> Pin<Box<dyn Future<Output = Option<()>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
}
Expand description

Service level protocol handle

Note

All functions on this trait will block the entire server running, do not insert long-time tasks, you can use the futures task instead.

Behavior

Define the behavior of each custom protocol in each state.

Depending on whether the user defines a service handle or a session exclusive handle, the runtime has different performance.

The important difference is that some state values are allowed in the service handle, and the handle exclusive to the session is “stateless”, relative to the service handle, it can only retain the information between a protocol stream on and off.

The opening and closing of the protocol will create and clean up the handle exclusive to the session, but the service handle will remain in the state until the service is closed.

Required Methods

This function is called when the service start.

The service handle will only be called once

Provided Methods

Called when opening protocol

Called when closing protocol

Called when the corresponding protocol message is received

Called when the Service receives the notify task

Behave like Stream::poll_next, but nothing output if ready with Some, it will continue poll immediately if ready with None, it will don’t try to call the function again

Trait Implementations

This function is called when the service start. Read more

Called when opening protocol

Called when closing protocol

Called when the corresponding protocol message is received

Called when the Service receives the notify task

Behave like Stream::poll_next, but nothing output if ready with Some, it will continue poll immediately if ready with None, it will don’t try to call the function again Read more

This function is called when the service start. Read more

Called when opening protocol

Called when closing protocol

Called when the corresponding protocol message is received

Called when the Service receives the notify task

Behave like Stream::poll_next, but nothing output if ready with Some, it will continue poll immediately if ready with None, it will don’t try to call the function again Read more

Implementations on Foreign Types

Implementors