MeshConnServices are configurations for exposing services to other nodes on a mesh.

Generated

from message v1.MeshConnServices

Hierarchy

Constructors

Properties

authMethod: NetworkAuthMethod = NetworkAuthMethod.NO_AUTH

AuthMetod is the of authentication to enable for the services. Only mTLS and ID are supported.

Generated

from field: v1.NetworkAuthMethod authMethod = 7;

DNS are configurations for running a MeshDNS server.

Generated

from field: v1.MeshDNSService dns = 9;

enableLibP2P: boolean = false

EnableLibP2P indicates whether or not to serve the API over libp2p.

Generated

from field: bool enableLibP2P = 2;

enableTLS: boolean = false

EnableTLS indicates whether or not to use TLS for the API.

Generated

from field: bool enableTLS = 3;

enabled: boolean = false

Enabled indicates whether or not to expose services to other nodes.

Generated

from field: bool enabled = 1;

features: Feature[] = []

Features are which features to enable on the API.

Generated

from field: repeated v1.Feature features = 8;

listenAddress: string = ""

ListenAddress is a raw IP address and port to listen on.

Generated

from field: string listenAddress = 5;

listenMultiaddrs: string[] = []

ListenMultiaddrs are multiaddrs to listen on. If not provided and EnableLibP2P is set, the default listen addresses will be used.

Generated

from field: repeated string listenMultiaddrs = 6;

rendezvous: string = ""

Rendezvous is an optional rendezvous string to use for anouncing the service on the IPFS DHT.

Generated

from field: string rendezvous = 4;

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

Methods

  • Create a deep copy.

    Returns MeshConnServices

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

  • Parse a message from a JSON value.

    Parameters

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

    Returns MeshConnServices

  • Parse a message from a JSON string.

    Parameters

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

    Returns MeshConnServices

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

    Returns MessageType<MeshConnServices>

  • 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