Struct SingleClientServerConnectionKernel

pub struct SingleClientServerConnectionKernel<F, Fut> { /* private fields */ }

This SingleClientServerConnectionKernel is the base kernel type for other built-in implementations of NetKernel. It establishes connections to a central node for purposes of NAT traversal and peer discovery, and depending on the application layer, can leverage the client to server connection for other purposes that require communication between the two.

Implementations

impl<F, Fut> SingleClientServerConnectionKernel<F, Fut>

where F: FnOnce(ConnectionSuccess, ClientServerRemote) -> Fut + Send, Fut: Future<Output = Result<(), NetworkError>> + Send,

pub fn new(settings: ServerConnectionSettings, on_channel_received: F) -> Self

Creates a new SingleClientServerConnectionKernel with the given settings. The ServerConnectionSettings must be provided, and the on_channel_received function will be called when the connection is established.

Trait Implementations

impl<F, Fut> NetKernel for SingleClientServerConnectionKernel<F, Fut>

where F: FnOnce(ConnectionSuccess, ClientServerRemote) -> Fut + Send, Fut: Future<Output = Result<(), NetworkError>> + Send,

fn load_remote(&mut self, server_remote: NodeRemote) -> Result<(), NetworkError>

when the kernel executes, it will be given a handle to the server

fn on_start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

After the server remote is passed to the kernel, this function will be called once to allow the application to make any initial calls

fn on_node_event_received<'life0, 'async_trait>( &'life0 self, message: NodeResult, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

When the server processes a valid entry, the value is sent here. Each call to ‘on_node_event_received’ is done concurrently (but NOT in parallel). This allows code inside this function to await without blocking new incoming messages

fn on_stop<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

When the system is ready to shutdown, this is called