ConnectionParameters are the parameters for a mesh connection.

Generated

from message v1.ConnectionParameters

Hierarchy

Constructors

Properties

addrType: ConnectionParameters_AddrType = ConnectionParameters_AddrType.ADDR

AddrType is the type of join addresses in the addrs list.

Generated

from field: v1.ConnectionParameters.AddrType addrType = 4;

addrs: string[] = []

Addrs are the join addresses to use to connect to the mesh.

Generated

from field: repeated string addrs = 5;

authCredentials: {
    [key: string]: string;
} = {}

AuthCredentials are additional credentials as required by the authType.

Type declaration

  • [key: string]: string

Generated

from field: map<string, string> authCredentials = 3;

authMethod: NetworkAuthMethod = NetworkAuthMethod.NO_AUTH

AuthMethod is the type of authentication to use.

Generated

from field: v1.NetworkAuthMethod authMethod = 2;

bootstrap?: MeshConnBootstrap

Bootstrap are options for bootstrapping a new mesh.

Generated

from field: v1.MeshConnBootstrap bootstrap = 8;

networking?: MeshConnNetworking

Networking is the networking configuration to use.

Generated

from field: v1.MeshConnNetworking networking = 6;

services?: MeshConnServices

Services are the services to expose to other nodes on the mesh.

Generated

from field: v1.MeshConnServices services = 7;

TLS are TLS configurations for the mesh connection.

Generated

from field: v1.MeshConnTLS tls = 9;

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

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 ConnectionParameters

  • Parse a message from a JSON value.

    Parameters

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

    Returns ConnectionParameters

  • Parse a message from a JSON string.

    Parameters

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

    Returns ConnectionParameters

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

    Returns MessageType<ConnectionParameters>

  • 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