JoinResponse is a response to a join request.

Generated

from message v1.JoinResponse

Hierarchy

Constructors

Properties

addressIPv4: string = ""

AddressIPv4 is the private IPv4 wireguard address of the node in CIDR format representing the network. This is only set if assign_ipv4 was set in the request or no network_ipv6 was provided.

Generated

from field: string addressIPv4 = 1;

addressIPv6: string = ""

AddressIPv6 is the IPv6 network assigned to the node.

Generated

from field: string addressIPv6 = 2;

dnsServers: string[] = []

DNSServers is a list of peers offering DNS services.

Generated

from field: repeated string dnsServers = 7;

iceServers: string[] = []

ICEServers is a list of public nodes that can be used to negotiate ICE connections if required. This may only be populated when one of the peers has the ICE flag set. This must be set if the requestor specifies direct_peers.

Generated

from field: repeated string iceServers = 6;

meshDomain: string = ""

MeshDomain is the domain of the mesh.

Generated

from field: string meshDomain = 8;

networkIPv4: string = ""

NetworkIPv4 is the IPv4 network of the Mesh.

Generated

from field: string networkIPv4 = 3;

networkIPv6: string = ""

NetworkIPv6 is the IPv6 network of the Mesh.

Generated

from field: string networkIPv6 = 4;

peers: WireGuardPeer[] = []

Peers is a list of wireguard peers to connect to.

Generated

from field: repeated v1.WireGuardPeer peers = 5;

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

Methods

  • Create a deep copy.

    Returns JoinResponse

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns JoinResponse

  • Parse a message from a JSON string.

    Parameters

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

    Returns JoinResponse

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

    Returns MessageType<JoinResponse>

  • 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