Enum TriggerEvent

pub enum TriggerEvent {
    NormalRecv,
    PaddingRecv,
    TunnelRecv,
    NormalSent,
    PaddingSent {
        machine: MachineId,
    },
    TunnelSent,
    BlockingBegin {
        machine: MachineId,
    },
    BlockingEnd,
    TimerBegin {
        machine: MachineId,
    },
    TimerEnd {
        machine: MachineId,
    },
}

Represents an event to be triggered in the framework.

Variants

NormalRecv

Received non-padding packet.

This event should be triggered once for each incoming non-padding packet, after TunnelRecv, as soon as we have identified the packet as non-padding.

PaddingRecv

Received padding packet.

This event should be triggered once for each incoming padding packet, after TunnelRecv, as soon as we have identified the packet as padding.

TunnelRecv

Received a complete packet in the tunnel.

This event should be triggered once for each incoming packet of any type, as soon as possible after the packet is received from the network, before the packet is queued, processed, or decrypted.

(No event should be generated for a partially read packet.)

NormalSent

Sent non-padding packet.

This event should be triggered once for each outgoing non-padding packet, as soon as we have decided put it on any internal queue.

PaddingSent

Sent padding packet.

This event should be triggered once for each outgoing padding packet, as soon as we have decided put it on any internal queue.

Fields

machine: MachineId

TunnelSent

Sent packet in the tunnel.

This event should be triggered once for each outgoing packet of any type, after that packet’s NormalSent or PaddingSent event, as close as possible to the time when it is actually written to the network.

BlockingBegin

Blocking of outgoing traffic started by the action from a machine.

This event should be triggered whenever the action timer for a crate::action::TriggerAction::BlockOutgoing action expires, whether the blocking timer is adjusted or not.

Fields

machine: MachineId

BlockingEnd

Blocking of outgoing traffic has stopped.

This event should be triggered when the framework-scoped blocking timer expires.

TimerBegin

A machine’s internal timer started, or was changed.

This event should be triggered any time a new internal timer is started, or whenever the expiration time of an machine’s internal timer changes.

Fields

machine: MachineId

TimerEnd

A machine’s internal timer expired.

(This event should not be sent in response to a timer being cancelled.)

Fields

machine: MachineId

Implementations

impl TriggerEvent

pub fn is_event(&self, e: Event) -> bool

Checks if the TriggerEvent is a particular Event.

Trait Implementations

impl Clone for TriggerEvent

fn clone(&self) -> TriggerEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerEvent

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

Formats the value using the given formatter.

impl Display for TriggerEvent

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

Formats the value using the given formatter.

impl Hash for TriggerEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TriggerEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TriggerEvent

impl StructuralPartialEq for TriggerEvent