Class Network

constructor

• new Network(client, id, connnection): Network

• Parameters

  • client: DaemonClient

  • id: string

  • connnection: GetConnectionResponse

  Returns Network

client

connected

connnection

details

id

domain

• get domain(): string

• domain returns the mesh domain of the connection.

  Returns string

fqdn

• get fqdn(): string

• fqdn returns the fully qualified domain name of the connection.

  Returns string

ipv4Address

• get ipv4Address(): string

• ipv4Address returns the IPv4 address of the connection.

  Returns string

ipv4Network

• get ipv4Network(): string

• ipv4Network returns the IPv4 network of the connection.

  Returns string

ipv6Address

• get ipv6Address(): string

• ipv6Address returns the IPv6 address of the connection.

  Returns string

ipv6Network

• get ipv6Network(): string

• ipv6Network returns the IPv6 network of the connection.

  Returns string

nodeID

• get nodeID(): string

• nodeID returns the node ID of the connection.

  Returns string

params

• get params(): Required<{
      id?: string;
      meta?: Required<undefined | ({ fields: Required<{ [x: string]: Required<{ kind: Required<{ value: NullValue; case: "nullValue"; } | { value: number; case: "numberValue"; } | { value: string; case: "stringValue"; } | { value: boolean; case: "boolValue"; } | { ...; } | { ...; } | { ...; }>; }>; [x: number]: Required<...>; }>; })>;
      params?: Required<undefined | ({ authMethod: NetworkAuthMethod; authCredentials: Required<{ [x: string]: string; }>; addrType: ConnectionParameters_AddrType; ... 13 more ...; getType: Required<...>; })>;
  }>

• parameters returns the network parameters.

  Returns Required<{
      id?: string;
      meta?: Required<undefined | ({ fields: Required<{ [x: string]: Required<{ kind: Required<{ value: NullValue; case: "nullValue"; } | { value: number; case: "numberValue"; } | { value: string; case: "stringValue"; } | { value: boolean; case: "boolValue"; } | { ...; } | { ...; } | { ...; }>; }>; [x: number]: Required<...>; }>; })>;
      params?: Required<undefined | ({ authMethod: NetworkAuthMethod; authCredentials: Required<{ [x: string]: string; }>; addrType: ConnectionParameters_AddrType; ... 13 more ...; getType: Required<...>; })>;
  }>

peers

• get peers(): MeshNodes

• peers returns an interface for working with the peers of the connection.

  Returns MeshNodes

status

• get status(): ConnectionStatus

• status returns the status of the connection.

  Returns ConnectionStatus

connect

• connect(): Promise<void>

• connect connects the node to the mesh.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• disconnect disconnects the node from the mesh.

  Returns Promise<void>

drop

• drop(): Promise<void>

• drop disconnects the node from the mesh and drops the connection from storage.

  Returns Promise<void>

metrics

• metrics(): Promise<InterfaceMetrics>

• metrics returns the metrics for the connection.

  Returns Promise<InterfaceMetrics>