Struct NodeSession

pub struct NodeSession { /* private fields */ }

Represents a remote connection to a node(). The NodeSession is the main handler for all inter-node communication and handles

1. The state of the authentication handshake
2. Control messages for actor synchronization + group membership changes
3. RemoteActors wishing to send messages to their remote counterparts on the remote system (and receive replies)

A NodeSession can either be a client or server session, depending on the connection sequence. If it was an incoming request to the crate::NodeServer then it’s a “server” session, as the server spawned this actor. Otherwise it’s an outgoing “client” request.

If the NodeSession is a client session, it will start the authentication handshake with a auth_protocol::NameMessage announcing this node’s name to the remote system for deduplication and starting the rest of the handshake. For full authentication pattern details, see

1. src/protocol/auth.proto
2. src/node/auth.rs

Lastly the node’s have an intern-node “ping” operation which occurs to keep the TCP session alive and additionally measure peer latency.

Implementations

impl NodeSession

pub fn new( node_id: NodeId, is_server: bool, cookie: String, node_server: ActorRef<NodeServerMessage>, node_name: NameMessage, connection_mode: NodeConnectionMode, ) -> Self

Construct a new NodeSession with the supplied arguments

• node_id: This peer’s node id
• is_server: Is a server-received session (if false, this is the client)
• cookie: The authorization cookie
• node_server: The parent node server
• node_name: This node’s name and connection details
• connection_mode: The connection mode for peer connections

Trait Implementations

impl Actor for NodeSession

type Msg = NodeSessionMessage

The message type for this actor

type Arguments = NetworkStream

Initialization arguments

type State = NodeSessionState

The type of state this actor manages internally

async fn pre_start( &self, myself: ActorRef<Self::Msg>, stream: Self::Arguments, ) -> Result<Self::State, ActorProcessingErr>

Invoked when an actor is being started by the system.

async fn post_stop( &self, myself: ActorRef<Self::Msg>, _state: &mut Self::State, ) -> Result<(), ActorProcessingErr>

Invoked after an actor has been stopped to perform final cleanup. In the event the actor is terminated with Signal::Kill or has self-panicked, post_stop won’t be called.

async fn handle( &self, myself: ActorRef<Self::Msg>, message: Self::Msg, state: &mut Self::State, ) -> Result<(), ActorProcessingErr>

Handle the incoming message from the event processing loop. Unhandled panickes will be captured and sent to the supervisor(s)

async fn handle_supervisor_evt( &self, myself: ActorRef<Self::Msg>, message: SupervisionEvent, state: &mut Self::State, ) -> Result<(), ActorProcessingErr>

Handle the incoming supervision event. Unhandled panics will be captured and sent the the supervisor(s). The default supervision behavior is to exit the supervisor on any child exit. To override this behavior, implement this function.

fn post_start( &self, myself: ActorRef<Self::Msg>, state: &mut Self::State, ) -> impl Future<Output = Result<(), Box<dyn Error + Sync + Send>>> + MaybeSend

Invoked after an actor has started.

fn handle_serialized( &self, myself: ActorRef<Self::Msg>, message: SerializedMessage, state: &mut Self::State, ) -> impl Future<Output = Result<(), Box<dyn Error + Sync + Send>>> + MaybeSend

Handle the remote incoming message from the event processing loop. Unhandled panickes will be captured and sent to the supervisor(s)

fn spawn( name: Option<String>, handler: Self, startup_args: Self::Arguments, ) -> impl Future<Output = Result<(ActorRef<Self::Msg>, JoinHandle<()>), SpawnErr>> + MaybeSend

Spawn an actor of this type, which is unsupervised, automatically starting

fn spawn_linked( name: Option<String>, handler: Self, startup_args: Self::Arguments, supervisor: ActorCell, ) -> impl Future<Output = Result<(ActorRef<Self::Msg>, JoinHandle<()>), SpawnErr>> + MaybeSend

Spawn an actor of this type with a supervisor, automatically starting the actor

impl Debug for NodeSession

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

Formats the value using the given formatter.