Enum Notification 

pub enum Notification {
    Client {
        event: ClientEvent,
        cid: u64,
        kid: Option<u64>,
        env: Vec<(String, String)>,
    },
    ClientAddress {
        cid: u64,
        addr: String,
        primary: bool,
    },
    State {
        timestamp: u64,
        name: OpenVpnState,
        description: String,
        local_ip: String,
        remote_ip: String,
        local_port: String,
        remote_port: String,
    },
    ByteCount {
        bytes_in: u64,
        bytes_out: u64,
    },
    ByteCountCli {
        cid: u64,
        bytes_in: u64,
        bytes_out: u64,
    },
    Log {
        timestamp: u64,
        level: LogLevel,
        message: String,
    },
    Echo {
        timestamp: u64,
        param: String,
    },
    Hold {
        text: String,
    },
    Fatal {
        message: String,
    },
    Pkcs11IdCount {
        count: u32,
    },
    NeedOk {
        name: String,
        message: String,
    },
    NeedStr {
        name: String,
        message: String,
    },
    RsaSign {
        data: String,
    },
    Remote {
        host: String,
        port: u16,
        protocol: TransportProtocol,
    },
    Proxy {
        proto_num: u32,
        proto_type: TransportProtocol,
        host: String,
        port: u16,
    },
    Password(PasswordNotification),
    Simple {
        kind: String,
        payload: String,
    },
}

A parsed real-time notification from OpenVPN.

Variants

Client

A multi-line >CLIENT: notification (CONNECT, REAUTH, ESTABLISHED, DISCONNECT). The header and all ENV key=value pairs are accumulated into a single struct before this is emitted.

Fields

event: ClientEvent

The client event sub-type.

cid: u64

Client ID (sequential, assigned by OpenVPN).

kid: Option<u64>

Key ID (present for CONNECT/REAUTH, absent for ESTABLISHED/DISCONNECT).

env: Vec<(String, String)>

Accumulated ENV pairs, in order. Each >CLIENT:ENV,key=val line becomes one (key, val) entry. The terminating >CLIENT:ENV,END is consumed but not included.

ClientAddress

A single-line >CLIENT:ADDRESS notification.

Fields

cid: u64

Client ID.

addr: String

Assigned virtual address.

primary: bool

Whether this is the primary address for the client.

State

>STATE:timestamp,name,description,local_ip,remote_ip[,local_port,remote_port]

Fields

timestamp: u64

Unix timestamp of the state change.

name: OpenVpnState

State name (e.g. Connected, Reconnecting).

description: String

Verbose description of the state.

local_ip: String

Local tunnel IP address (may be empty).

remote_ip: String

Remote server IP address (may be empty).

local_port: String

Local port (may be empty, OpenVPN 2.1+).

remote_port: String

Remote port (may be empty, OpenVPN 2.1+).

ByteCount

>BYTECOUNT:bytes_in,bytes_out (client mode)

Fields

bytes_in: u64

Bytes received since last reset.

bytes_out: u64

Bytes sent since last reset.

ByteCountCli

>BYTECOUNT_CLI:cid,bytes_in,bytes_out (server mode, per-client)

Fields

cid: u64

Client ID.

bytes_in: u64

Bytes received from this client.

bytes_out: u64

Bytes sent to this client.

Log

>LOG:timestamp,level,message

Fields

timestamp: u64

Unix timestamp of the log entry.

level: LogLevel

Log severity level.

message: String

The log message text.

Echo

>ECHO:timestamp,param_string

Fields

timestamp: u64

Unix timestamp.

param: String

The echoed parameter string.

Hold

>HOLD:Waiting for hold release[:N]

Fields

text: String

The hold message text.

Fatal

>FATAL:message

Fields

message: String

The fatal error message.

Pkcs11IdCount

>PKCS11ID-COUNT:count

Fields

count: u32

Number of available PKCS#11 identities.

NeedOk

>NEED-OK:Need 'name' confirmation MSG:message

Fields

name: String

The prompt name.

message: String

The prompt message to display.

NeedStr

>NEED-STR:Need 'name' input MSG:message

Fields

name: String

The prompt name.

message: String

The prompt message to display.

RsaSign

>RSA_SIGN:base64_data

Fields

data: String

Base64-encoded data to be signed.

Remote

>REMOTE:host,port,protocol

Fields

host: String

Remote server hostname or IP.

port: u16

Remote server port.

protocol: TransportProtocol

Transport protocol.

Proxy

>PROXY:proto_num,proto_type,host[,port]

Fields

proto_num: u32

Numeric protocol identifier.

proto_type: TransportProtocol

Transport protocol type.

host: String

Server hostname or IP.

port: u16

Server port (0 if not provided by the server).

Password(PasswordNotification)

>PASSWORD:... — see PasswordNotification for the sub-types.

Simple

Fallback for any notification type not explicitly modeled above. Kept for forward compatibility with future OpenVPN versions.

Fields

kind: String

The notification type keyword (e.g. "BYTECOUNT").

payload: String

Everything after the first colon.

Trait Implementations

impl Clone for Notification

fn clone(&self) -> Notification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Notification

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

Formats the value using the given formatter.

impl PartialEq for Notification

fn eq(&self, other: &Notification) -> 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 Notification

impl StructuralPartialEq for Notification