PeerMetrics are the metrics for a node's peer.

Generated

from message v1.PeerMetrics

Hierarchy

Constructors

Properties

allowedIPs: string[] = []

AllowedIPs is the list of allowed IPs for the peer.

Generated

from field: repeated string allowedIPs = 5;

endpoint: string = ""

Endpoint is the connected endpoint of the peer.

Generated

from field: string endpoint = 2;

lastHandshakeTime: string = ""

LastHandshakeTime is the last handshake time for the peer.

Generated

from field: string lastHandshakeTime = 4;

persistentKeepAlive: string = ""

PersistentKeepAlive is the persistent keep alive interval for the peer.

Generated

from field: string persistentKeepAlive = 3;

protocolVersion: bigint = protoInt64.zero

ProtocolVersion is the version of the wireguard protocol negotiated with the peer.

Generated

from field: int64 protocolVersion = 6;

publicKey: string = ""

PublicKey is the public key of the peer.

Generated

from field: string publicKey = 1;

receiveBytes: bigint = protoInt64.zero

ReceiveBytes is the bytes received from the peer.

Generated

from field: uint64 receiveBytes = 7;

transmitBytes: bigint = protoInt64.zero

TransmitBytes is the bytes transmitted to the peer.

Generated

from field: uint64 transmitBytes = 8;

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

Methods

  • Create a deep copy.

    Returns PeerMetrics

  • 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 PeerMetrics

  • Parse a message from a JSON value.

    Parameters

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

    Returns PeerMetrics

  • Parse a message from a JSON string.

    Parameters

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

    Returns PeerMetrics

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

    Returns MessageType<PeerMetrics>

  • 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