Struct citadel_sdk::prefabs::client::broadcast::BroadcastKernel

pub struct BroadcastKernel<'a, F, Fut> { /* private fields */ }

A kernel that streamlines creating, connecting, and interacting with groups Each group has a single owner, and, each connecting peer must at least be registered to the owner alone. The owner thus serves as an “axis of consent”, where each member trusts the owner, and through this trust, transitivity of trust flows to all other future members that connect to the group.

Trait Implementations

impl<F, Fut> NetKernel for BroadcastKernel<'_, F, Fut>

fn load_remote(&mut self, node_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

impl<'a, F, Fut> PrefabFunctions<'a, GroupInitRequestType> for BroadcastKernel<'a, F, Fut>

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

type UserLevelInputFunction = F

type SharedBundle = Arc<BroadcastShared>

Shared between the kernel and the on_c2s_channel_received function

fn get_shared_bundle(&self) -> Self::SharedBundle

fn on_c2s_channel_received<'async_trait>( connect_success: ConnectionSuccess, remote: ClientServerRemote, arg: GroupInitRequestType, fx: Self::UserLevelInputFunction, shared: Arc<BroadcastShared>, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>

where Self: 'async_trait,

fn construct(kernel: Box<dyn NetKernel + 'a>) -> Self

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

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

fn new_connect_defaults<T: Into<String>, P: Into<SecBuffer>>( username: T, password: P, arg: Arg, on_channel_received: Self::UserLevelInputFunction, ) -> Self

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

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

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

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

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

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

Creates a new authless connection with custom arguments

fn new_authless_defaults<V: ToSocketAddrs>( uuid: Uuid, server_addr: V, arg: Arg, on_channel_received: Self::UserLevelInputFunction, ) -> Result<Self, NetworkError>

Creates a new authless connection with default arguments