Struct CitadelClientServerConnection 

pub struct CitadelClientServerConnection<R: Ratchet> {
    pub remote: ClientServerRemote<R>,
    pub udp_channel_rx: Option<Receiver<UdpChannel<R>>>,
    pub services: ServicesObject,
    pub cid: u64,
    pub session_security_settings: SessionSecuritySettings,
    /* private fields */
}

Contains the elements required to communicate with the adjacent node

Fields

remote: ClientServerRemote<R>

udp_channel_rx: Option<Receiver<UdpChannel<R>>>

Only available if UdpMode was enabled at the beginning of a session

services: ServicesObject

Contains the Google auth minted at the central server (if the central server enabled it), as well as any other services enabled by the central server

cid: u64

session_security_settings: SessionSecuritySettings

Implementations

impl<R: Ratchet> CitadelClientServerConnection<R>

pub fn split(self) -> (PeerChannelSendHalf<R>, PeerChannelRecvHalf<R>)

Splits the channel into a send and receive half. This will render the other fields of this connection object innaccessible

Panics

• If the channel has already been taken

pub fn take_channel(&mut self) -> Option<PeerChannel<R>>

Methods from Deref<Target = ClientServerRemote<R>>

pub fn get_unprocessed_signals_receiver( &self, ) -> Option<UnboundedReceiver<NodeResult<R>>>

Can only be called once per remote. Allows receiving events

pub fn get_incoming_file_transfer_handle( &self, ) -> Result<FileTransferHandleRx, NetworkError>

Obtains a receiver which yields incoming file/object transfer handles

pub async fn shutdown_kernel(&self) -> Result<(), NetworkError>

Gracefully closes the protocol and kernel executor

pub async fn get_peers( &self, limit: Option<usize>, ) -> Result<Vec<LocalGroupPeer>, NetworkError>

Methods from Deref<Target = NodeRemote<R>>

pub fn rebind_local(&self) -> Result<RebindReport, NetworkError>

Moves every client-role QUIC endpoint this node holds (C2S QUIC, and the dialing side of direct and TURN P2P paths) to a fresh socket on the current local address, so their connections migrate without a new handshake. Call it when the local network changes. Local only: nothing crosses the wire. See proto::misc::local_rebind for what cannot move.

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

Sends a request to the server with a custom ticket.

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

Sends a request to the server and returns a ticket for tracking the response.

pub async fn send_callback_subscription( &self, request: NodeRequest, ) -> Result<KernelStreamSubscription<R>, NetworkError>

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

pub async fn shutdown(&self) -> 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<R, R>

Trait Implementations

impl<R: Ratchet> Deref for CitadelClientServerConnection<R>

type Target = ClientServerRemote<R>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<R: Ratchet> DerefMut for CitadelClientServerConnection<R>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<R: Ratchet> SignInManagementExt for CitadelClientServerConnection<R>

fn manage_sign_in<'life0, 'async_trait>( &'life0 self, op: SignInManagementOp, step_up: SignInFactors, ) -> Pin<Box<dyn Future<Output = Result<SignInManagementOutcome, NetworkError>> + Send + 'async_trait>>

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

Runs one change. step_up holds the factors the account’s policy asks for (and, for AddSecurityKey, the key channel that is asked for the new key’s PRF output).