Enum ControlMessage 

pub enum ControlMessage {
    Send {
        to_pid: u64,
    },
    RegSend {
        to_name: Atom,
    },
    PgJoin {
        scope: Atom,
        group: Atom,
        node: Atom,
        pid_number: u64,
        serial: u64,
    },
    PgLeave {
        scope: Atom,
        group: Atom,
        node: Atom,
        pid_number: u64,
        serial: u64,
    },
    Link {
        from: RemotePid,
        to_pid: u64,
    },
    Unlink {
        from: RemotePid,
        to_pid: u64,
    },
    Exit {
        from: RemotePid,
        to_pid: u64,
        reason: ExitReason,
    },
    Exit2 {
        from: RemotePid,
        to_pid: u64,
        reason: ExitReason,
    },
}

Decoded distribution control message.

Fields are extracted values rather than raw Terms because the decode process heap is temporary — boxed Terms would become dangling after return.

Variants

Send

{2, Cookie, ToPid} — stores extracted pid number.

Fields

to_pid: u64

RegSend

{6, FromPid, Cookie, ToName} — stores extracted name atom.

Fields

to_name: Atom

PgJoin

{101, 1, Scope, Group, MemberExternalPid} — a remote process-group join.

node/pid_number/serial are extracted from the member PID, which is always encoded as an external PID carrying the originating node’s name so that the receiver records a fully-qualified RemoteMember rather than a node-less local PID.

Fields

scope: Atom

Scope atom the member joined.

group: Atom

Group atom the member joined.

node: Atom

Originating node atom (from the member’s external PID).

pid_number: u64

Member PID number on the originating node.

serial: u64

Member PID serial on the originating node.

PgLeave

{101, 2, Scope, Group, MemberExternalPid} — a remote process-group leave.

Fields

scope: Atom

Scope atom the member left.

group: Atom

Group atom the member left.

node: Atom

Originating node atom (from the member’s external PID).

pid_number: u64

Member PID number on the originating node.

serial: u64

Member PID serial on the originating node.

Link

{1, FromExtPid, ToExtPid} — establish a remote link on local to_pid.

Fields

from: RemotePid

Remote endpoint requesting the link.

to_pid: u64

Local target PID number (extracted from the addressed to pid).

Unlink

{4, FromExtPid, ToExtPid} — remove a remote link from local to_pid.

Fields

from: RemotePid

Remote endpoint removing the link.

to_pid: u64

Local target PID number (extracted from the addressed to pid).

Exit

{3, FromExtPid, ToExtPid, ReasonAtom} — link-exit signal (op 3).

Fields

from: RemotePid

Remote endpoint that died while linked to to_pid.

to_pid: u64

Local target PID number (extracted from the addressed to pid).

reason: ExitReason

Terminal exit reason carried on the wire.

Exit2

{8, FromExtPid, ToExtPid, ReasonAtom} — exit/2 signal (op 8).

Fields

from: RemotePid

Remote caller of exit/2.

to_pid: u64

Local target PID number (extracted from the addressed to pid).

reason: ExitReason

Raw exit reason carried on the wire (MAY be kill).

Trait Implementations

impl Clone for ControlMessage

fn clone(&self) -> ControlMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ControlMessage

impl Debug for ControlMessage

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

Formats the value using the given formatter.

impl Eq for ControlMessage

impl PartialEq for ControlMessage

fn eq(&self, other: &ControlMessage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ControlMessage