InterfaceMetrics is the metrics for the WireGuard interface on a node.

Generated

from message v1.InterfaceMetrics

Hierarchy

Constructors

Properties

addressV4: string = ""

AddressV4 is the IPv4 address of the node.

Generated

from field: string addressV4 = 3;

addressV6: string = ""

AddressV6 is the IPv6 address of the node.

Generated

from field: string addressV6 = 4;

deviceName: string = ""

DeviceName is the name of the device.

Generated

from field: string deviceName = 1;

listenPort: number = 0

ListenPort is the port wireguard is listening on.

Generated

from field: int32 listenPort = 6;

numPeers: number = 0

NumPeers is the number of peers connected to the node.

Generated

from field: int32 numPeers = 9;

peers: PeerMetrics[] = []

Peers are the per-peer statistics.

Generated

from field: repeated v1.PeerMetrics peers = 10;

publicKey: string = ""

PublicKey is the public key of the node.

Generated

from field: string publicKey = 2;

totalReceiveBytes: bigint = protoInt64.zero

TotalReceiveBytes is the total number of bytes received.

Generated

from field: uint64 totalReceiveBytes = 7;

totalTransmitBytes: bigint = protoInt64.zero

TotalTransmitBytes is the total number of bytes transmitted.

Generated

from field: uint64 totalTransmitBytes = 8;

type: string = ""

Type is the type of interface being used for wireguard.

Generated

from field: string type = 5;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "v1.InterfaceMetrics" = "v1.InterfaceMetrics"

Methods

  • Create a deep copy.

    Returns InterfaceMetrics

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns InterfaceMetrics

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns InterfaceMetrics

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns InterfaceMetrics

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<InterfaceMetrics>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Generated using TypeDoc