GetConnectionResponse is returned by the GetConnection RPC.

Generated

from message v1.GetConnectionResponse

Hierarchy

Constructors

Properties

domain: string = ""

Domain is the domain of the mesh. This is only populated when the connection is connected.

Generated

from field: string domain = 7;

ipv4Network: string = ""

IPv4Network is the IPv4 network of the mesh. This is only populated when the connection is connected.

Generated

from field: string ipv4Network = 5;

ipv6Network: string = ""

IPv6Network is the IPv6 network of the mesh. This is only populated when the connection is connected.

Generated

from field: string ipv6Network = 6;

metadata?: Struct

Metadata are arbitrary key/value pairs stored with the connection.

Generated

from field: google.protobuf.Struct metadata = 3;

node?: MeshNode

Node is the node information for the connection. This is only populated when the connection is connected.

Generated

from field: v1.MeshNode node = 4;

Parameters are the parameters for the connection.

Generated

from field: v1.ConnectionParameters parameters = 2;

status: DaemonConnStatus = DaemonConnStatus.DISCONNECTED

Status is the status of the connection.

Generated

from field: v1.DaemonConnStatus status = 1;

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

Methods

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns GetConnectionResponse

  • Parse a message from a JSON string.

    Parameters

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

    Returns GetConnectionResponse

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

    Returns MessageType<GetConnectionResponse>

  • 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