Struct citadel_sdk::prelude::NodeRemote

pub struct NodeRemote { /* private fields */ }

allows convenient communication with the server

Implementations

impl NodeRemote

pub async fn send_with_custom_ticket( &self, ticket: Ticket, request: NodeRequest ) -> impl Future<Output = Result<(), NetworkError>>

Especially used to keep track of a conversation (b/c a certain ticket number may be expected)

pub async fn send( &self, request: NodeRequest ) -> impl Future<Output = Result<Ticket, NetworkError>>

Sends a request to the HDP server. This should always be used to communicate with the server in order to obtain a ticket

pub async fn send_callback_custom_ticket( &self, request: NodeRequest, ticket: Ticket ) -> impl Future<Output = Result<NodeResult, NetworkError>>

Returns an error if the ticket is already registered for a callback

pub async fn send_callback_subscription( &self, request: NodeRequest ) -> impl Future<Output = Result<KernelStreamSubscription, NetworkError>>

Convenience method for sending and awaiting for a response for the related ticket

pub async fn send_callback( &self, request: NodeRequest ) -> impl Future<Output = Result<NodeResult, NetworkError>>

Convenience method for sending and awaiting for a response for the related ticket

pub async fn send_callback_timeout( &self, request: NodeRequest, timeout: Duration ) -> impl Future<Output = Result<NodeResult, NetworkError>>

Convenience method for sending and awaiting for a response for the related ticket (with a timeout)

pub async fn shutdown(&self) -> impl Future<Output = Result<(), NetworkError>>

Safely shutsdown the internal server

pub fn get_next_ticket(&self) -> Ticket

pub fn try_send_with_custom_ticket( &self, ticket: Ticket, request: NodeRequest ) -> Result<(), TrySendError<(NodeRequest, Ticket)>>

pub fn try_send( &self, request: NodeRequest ) -> Result<(), TrySendError<(NodeRequest, Ticket)>>

pub fn local_node_type(&self) -> &NodeType

pub fn account_manager(&self) -> &AccountManager<StackedRatchet, ThinRatchet>

Trait Implementations

impl Clone for NodeRemote

fn clone(&self) -> NodeRemote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeRemote

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl ProtocolRemoteExt for NodeRemote

fn register<'life0, 'async_trait, T, R, V, K>( &'life0 self, addr: T, full_name: R, username: V, proposed_password: K, default_security_settings: SessionSecuritySettings ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + ToSocketAddrs + Send, R: 'async_trait + Into<String> + Send, V: 'async_trait + Into<String> + Send, K: 'async_trait + Into<SecBuffer> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Registers with custom settings Returns a ticket which is used to uniquely identify the request in the protocol

fn register_with_defaults<'life0, 'async_trait, T, R, V, K>( &'life0 self, addr: T, full_name: R, username: V, proposed_password: K ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + ToSocketAddrs + Send, R: 'async_trait + Into<String> + Send, V: 'async_trait + Into<String> + Send, K: 'async_trait + Into<SecBuffer> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Registers using the default settings. The default uses No Google FCM keys and the default session security settings Returns a ticket which is used to uniquely identify the request in the protocol

fn connect<'life0, 'async_trait>( &'life0 self, auth: AuthenticationRequest, connect_mode: ConnectMode, udp_mode: UdpMode, keep_alive_timeout: Option<Duration>, session_security_settings: SessionSecuritySettings ) -> Pin<Box<dyn Future<Output = Result<ConnectionSuccess, NetworkError>> + Send + 'async_trait>>where Self: Sync + 'async_trait, 'life0: 'async_trait,

Connects with custom settings Returns a ticket which is used to uniquely identify the request in the protocol

fn connect_with_defaults<'life0, 'async_trait>( &'life0 self, auth: AuthenticationRequest ) -> Pin<Box<dyn Future<Output = Result<ConnectionSuccess, NetworkError>> + Send + 'async_trait>>where Self: Sync + 'async_trait, 'life0: 'async_trait,

Connects with the default settings If FCM keys were created during the registration phase, then those keys will be used for the session. If new FCM keys need to be used, consider using Self::connect

fn find_target<'life0, 'async_trait, T, R>( &'life0 self, local_user: T, peer: R ) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_>, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + Into<UserIdentifier> + Send, R: 'async_trait + Into<UserIdentifier> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Creates a valid target identifier used to make protocol requests. Raw user IDs or usernames can be used

fn propose_target<'life0, 'async_trait, T, P>( &'life0 self, local_user: T, peer: P ) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_>, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + Into<UserIdentifier> + Send, P: 'async_trait + Into<UserIdentifier> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Creates a proposed target from the valid local user to an unregistered peer in the network. Used when creating registration requests for peers. Currently only supports LocalGroup <-> LocalGroup peer connections

fn get_local_group_peers<'life0, 'async_trait, T>( &'life0 self, local_user: T, limit: Option<usize> ) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeer>, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + Into<UserIdentifier> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Returns a list of local group peers on the network for local_user. May or may not be registered to the user. To get a list of registered users to local_user, run Self::get_local_group_mutual_peers

fn get_local_group_mutual_peers<'life0, 'async_trait, T>( &'life0 self, local_user: T ) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeer>, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + Into<UserIdentifier> + Send, Self: Sync + 'async_trait, 'life0: 'async_trait,

Returns a list of mutually-registered peers with the local_user

impl Remote for NodeRemote

fn send<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<Ticket, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,

fn send_with_custom_ticket<'life0, 'async_trait>( &'life0 self, ticket: Ticket, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,

fn send_callback_subscription<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<KernelStreamSubscription, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,

fn send_callback<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<NodeResult, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,

fn account_manager(&self) -> &AccountManager<StackedRatchet, ThinRatchet>

fn get_next_ticket(&self) -> Ticket

impl Unpin for NodeRemote