Struct citadel_sdk::prefabs::client::single_connection::SingleClientServerConnectionKernel

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

A kernel that connects with the given credentials. If the credentials are not yet registered, then the Self::new_register function may be used, which will register the account before connecting. This kernel will only allow outbound communication for the provided account.

This NetKernel is the base kernel type for other built-in implementations of NetKernel

Implementations

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

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

pub fn new_connect<T: Into<String>, P: Into<SecBuffer>>( username: T, password: P, udp_mode: UdpMode, session_security_settings: SessionSecuritySettings, server_password: Option<PreSharedKey>, on_channel_received: F, ) -> Self

Creates a new connection with a central server entailed by the user information

pub fn new_connect_defaults<T: Into<String>, P: Into<SecBuffer>>( username: T, password: P, on_channel_received: F, ) -> Self

Crates a new connection with a central server entailed by the user information and default configuration

pub fn new_register<T: Into<String>, R: Into<String>, P: Into<SecBuffer>, V: ToSocketAddrs>( full_name: T, username: R, password: P, server_addr: V, udp_mode: UdpMode, session_security_settings: SessionSecuritySettings, server_password: Option<PreSharedKey>, on_channel_received: F, ) -> Result<Self, NetworkError>

First registers with a central server with the proposed credentials, and thereafter, establishes a connection with custom parameters

pub fn new_register_defaults<T: Into<String>, R: Into<String>, P: Into<SecBuffer>, V: ToSocketAddrs>( full_name: T, username: R, password: P, server_addr: V, on_channel_received: F, ) -> Result<Self, NetworkError>

First registers with a central server with the proposed credentials, and thereafter, establishes a connection with default parameters

pub fn new_authless<V: ToSocketAddrs>( uuid: Uuid, server_addr: V, udp_mode: UdpMode, session_security_settings: SessionSecuritySettings, server_password: Option<PreSharedKey>, on_channel_received: F, ) -> Result<Self, NetworkError>

Creates a new authless connection with custom arguments

pub fn new_passwordless_defaults<V: ToSocketAddrs>( uuid: Uuid, server_addr: V, on_channel_received: F, ) -> Result<Self, NetworkError>

Creates a new authless connection with default arguments

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