Class NodeConnection

Hierarchy

CreateDestroy
- NodeConnection

Constructors

constructor

new NodeConnection(__namedParameters): NodeConnection
Parameters
- __namedParameters: {
      certChain: Readonly<X509Certificate>[];
      connectionId: string;
      host: Host;
      hostname?: Hostname;
      localHost: Host;
      localPort: Port;
      logger: Logger;
      nodeId: NodeId;
      port: Port;
      quicClient?: QUICClient;
      quicConnection: QUICConnection;
      rpcClient: RPCClient<{
          nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
          nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
          nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
              success: true;
          }>>;
          nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
          nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
          nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
          nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
          nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
          vaultsGitInfoGet: RawCaller;
          vaultsGitPackGet: RawCaller;
          vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
      }>;
      validatedNodeId: NodeId;
  }
  - certChain: Readonly<X509Certificate>[]
  - connectionId: string
  - host: Host
  - Optional hostname?: Hostname
  - localHost: Host
  - localPort: Port
  - logger: Logger
  - nodeId: NodeId
  - port: Port
  - Optional quicClient?: QUICClient
  - quicConnection: QUICConnection
  - rpcClient: RPCClient<{
        nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
        nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
        nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
            success: true;
        }>>;
        nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
        nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
        nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
        nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
        nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
        vaultsGitInfoGet: RawCaller;
        vaultsGitPackGet: RawCaller;
        vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
    }>
  - validatedNodeId: NodeId
Returns NodeConnection
Inherited from createDestroy.CreateDestroy.constructor
- Defined in src/nodes/NodeConnection.ts:449

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Readonly` certChain

certChain: Readonly<X509Certificate>[]

`Readonly` connectionId

connectionId: string

`Readonly` host

host: Host

`Optional` `Readonly` hostname

hostname?: Hostname

Hostname is defined if the target's host was resolved from this hostname Undefined if a Host was directly provided

`Readonly` localHost

localHost: Host

`Readonly` localPort

localPort: Port

`Protected` logger

logger: Logger

`Readonly` nodeId

nodeId: NodeId

The most current NodeId of the peer's cert chain

`Readonly` port

port: Port

`Readonly` quicClient

quicClient: undefined | QUICClient

`Readonly` quicConnection

quicConnection: QUICConnection

`Readonly` rpcClient

Type declaration

nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>
nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>
nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
success: true;
}>>
nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>
nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>
nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>
nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>
nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>
nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>
vaultsGitInfoGet: RawCaller
vaultsGitPackGet: RawCaller
vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>

`Readonly` validatedNodeId

validatedNodeId: NodeId

The NodeId that it was validated on when verifying the peer

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from createDestroy.CreateDestroy.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:6

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from createDestroy.CreateDestroy.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from createDestroy.CreateDestroy.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from createDestroy.CreateDestroy.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from createDestroy.CreateDestroy.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from createDestroy.CreateDestroy.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:8

[status]

get [status](): Status
Returns Status
Inherited from createDestroy.CreateDestroy.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:7

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from createDestroy.CreateDestroy.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

destroy

destroy(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  force?: boolean;
  } = {}
  - Optional force?: boolean
Returns Promise<void>
Inherited from createDestroy.CreateDestroy.destroy
- Defined in src/nodes/NodeConnection.ts:493

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from createDestroy.CreateDestroy.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getClient

getClient(): RPCClient<{
    nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
    nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
    nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
        success: true;
    }>>;
    nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
    nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
    nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
    nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
    nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
    vaultsGitInfoGet: RawCaller;
    vaultsGitPackGet: RawCaller;
    vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
}>
Gets RPCClient for this node connection

Returns RPCClient<{
    nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
    nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
    nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
        success: true;
    }>>;
    nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
    nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
    nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
    nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
    nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
    notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
    vaultsGitInfoGet: RawCaller;
    vaultsGitPackGet: RawCaller;
    vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
}>
- Defined in src/nodes/NodeConnection.ts:552

`Protected` handleEventAll

handleEventAll(evt): void
Propagates all events from the QUICClient or QUICConnection upwards. If the QUICClient exists then it is just registered to that, otherwise just the QUICConnection. Will only re-dispatch the event if it's an AbstractEvent.
Parameters
- evt: EventAll<Event>
Returns void
- Defined in src/nodes/NodeConnection.ts:155

`Protected` handleEventNodeConnectionClose

handleEventNodeConnectionClose(_evt): Promise<void>
Triggers the destruction of the NodeConnection. Since this is only in response to an underlying problem or close it will force destroy. Dispatched by the EventNodeConnectionError event as the EventNodeConnectionError -> EventNodeConnectionClose event path.
Parameters
- _evt: EventNodeConnectionClose
Returns Promise<void>
- Defined in src/nodes/NodeConnection.ts:83

`Protected` handleEventNodeConnectionError

handleEventNodeConnectionError(evt): void
Dispatches a EventNodeConnectionClose in response to any NodeConnection error event. Will trigger destruction of the NodeConnection via the EventNodeConnectionError -> EventNodeConnectionClose event path.
Parameters
- evt: EventNodeConnectionError
Returns void
- Defined in src/nodes/NodeConnection.ts:70

`Protected` handleEventQUICClientDestroyed

handleEventQUICClientDestroyed(_evt): void
Parameters
- _evt: EventQUICClientDestroyed
Returns void
- Defined in src/nodes/NodeConnection.ts:127

`Protected` handleEventQUICConnectionStopped

handleEventQUICConnectionStopped(_evt): void
Parameters
- _evt: EventQUICConnectionStopped
Returns void
- Defined in src/nodes/NodeConnection.ts:138

`Protected` handleEventQUICConnectionStream

handleEventQUICConnectionStream(evt): void
Redispatches a QUICStream from a EventQUICConnectionStream event with a EventNodeConnectionStream event. Should bubble upwards through the NodeConnectionManager.
Parameters
- evt: EventQUICConnectionStream
Returns void
- Defined in src/nodes/NodeConnection.ts:98

`Protected` handleEventQUICError

handleEventQUICError(evt): void
Redispatches QUICConnection or QUICClient error events as NodeConnection error events. This should trigger the destruction of the NodeConnection through the EventNodeConnectionError -> EventNodeConnectionClose event path.
Parameters
- evt: EventQUICConnectionError
Returns void
- Defined in src/nodes/NodeConnection.ts:113

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from createDestroy.CreateDestroy.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

`Static` createNodeConnection

createNodeConnection(__namedParameters, ctx?): PromiseCancellable<NodeConnection>
Parameters
- __namedParameters: {
      connectionInitialMaxStreamsBidi?: number;
      connectionInitialMaxStreamsUni?: number;
      connectionKeepAliveIntervalTime?: number;
      connectionKeepAliveTimeoutTime?: number;
      logger?: Logger;
      manifest: {
          nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
          nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
          nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
              success: true;
          }>>;
          nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
          nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
          nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
          nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
          nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
          vaultsGitInfoGet: RawCaller;
          vaultsGitPackGet: RawCaller;
          vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
      };
      quicSocket?: QUICSocket;
      targetHost: Host;
      targetHostname?: Hostname;
      targetNodeIds: NodeId[];
      targetPort: Port;
      tlsConfig: TLSConfig;
  }
  - Optional connectionInitialMaxStreamsBidi?: number
  - Optional connectionInitialMaxStreamsUni?: number
  - Optional connectionKeepAliveIntervalTime?: number
  - Optional connectionKeepAliveTimeoutTime?: number
  - Optional logger?: Logger
  - manifest: {
        nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
        nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
        nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
            success: true;
        }>>;
        nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
        nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
        nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
        nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
        nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
        vaultsGitInfoGet: RawCaller;
        vaultsGitPackGet: RawCaller;
        vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
    }
    - nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>
    - nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>
    - nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
      success: true;
      }>>
    - nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>
    - nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>
    - nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>
    - nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>
    - nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>
    - vaultsGitInfoGet: RawCaller
    - vaultsGitPackGet: RawCaller
    - vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>
  - Optional quicSocket?: QUICSocket
  - targetHost: Host
  - Optional targetHostname?: Hostname
  - targetNodeIds: NodeId[]
  - targetPort: Port
  - tlsConfig: TLSConfig
- Optional ctx: Partial<ContextTimedInput>
Returns PromiseCancellable<NodeConnection>
- Defined in src/nodes/NodeConnection.ts:164

`Static` createNodeConnectionReverse

createNodeConnectionReverse(__namedParameters): NodeConnection
Parameters
- __namedParameters: {
      certChain: Readonly<X509Certificate>[];
      logger?: Logger;
      manifest: {
          nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
          nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
          nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
              success: true;
          }>>;
          nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
          nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
          nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
          nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
          nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
          notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
          vaultsGitInfoGet: RawCaller;
          vaultsGitPackGet: RawCaller;
          vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
      };
      nodeId: NodeId;
      quicConnection: QUICConnection;
  }
  - certChain: Readonly<X509Certificate>[]
  - Optional logger?: Logger
  - manifest: {
        nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>;
        nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>;
        nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
            success: true;
        }>>;
        nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>;
        nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>;
        nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>;
        nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>;
        nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>;
        notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>;
        vaultsGitInfoGet: RawCaller;
        vaultsGitPackGet: RawCaller;
        vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>;
    }
    - nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>
    - nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>
    - nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
      success: true;
      }>>
    - nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>
    - nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>
    - nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>
    - nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>
    - nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>
    - notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>
    - vaultsGitInfoGet: RawCaller
    - vaultsGitPackGet: RawCaller
    - vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>
  - nodeId: NodeId
  - quicConnection: QUICConnection
Returns NodeConnection
- Defined in src/nodes/NodeConnection.ts:376

Class NodeConnection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

certChain: Readonly<X509Certificate>[]

connectionId: string

host: Host

Optional hostname?: Hostname

localHost: Host

localPort: Port

logger: Logger

nodeId: NodeId

port: Port

Optional quicClient?: QUICClient

quicConnection: QUICConnection

validatedNodeId: NodeId

Returns NodeConnection

Properties

Readonly [initLock]

Readonly certChain

Readonly connectionId

Readonly host

Optional Readonly hostname

Readonly localHost

Readonly localPort

Protected logger

Readonly nodeId

Readonly port

Readonly quicClient

Readonly quicConnection

Readonly rpcClient

Type declaration

nodesAuditEventsGet: ServerCaller<AgentRPCRequestParams<AuditIdMessage>, AgentRPCResponseResult<AgentAuditMessage<AuditEvent>>>

nodesAuthenticateConnection: UnaryCaller<AgentRPCRequestParams<NodesAuthenticateConnectionMessage>, AgentRPCResponseResult<nodes.agent.types.SuccessMessage>>

nodesClaimNetworkSign: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>

nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{ success: true; }>>

nodesClaimsGet: ServerCaller<AgentRPCRequestParams<NodesClaimsGetMessage>, AgentRPCResponseResult<AgentClaimMessage>>

nodesClosestActiveConnectionsGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<ActiveConnectionDataMessage>>

nodesClosestLocalNodesGet: ServerCaller<AgentRPCRequestParams<nodes.agent.types.NodeIdMessage>, AgentRPCResponseResult<NodeContactMessage>>

nodesConnectionSignalFinal: UnaryCaller<AgentRPCRequestParams<HolePunchRequestMessage>, AgentRPCResponseResult>

nodesConnectionSignalInitial: UnaryCaller<AgentRPCRequestParams<HolePunchSignalMessage>, AgentRPCResponseResult<nodes.agent.types.AddressMessage>>

nodesCrossSignClaim: DuplexCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<AgentClaimMessage>>

notificationsSend: UnaryCaller<AgentRPCRequestParams<SignedNotificationEncoded>, AgentRPCResponseResult>

vaultsGitInfoGet: RawCaller

vaultsGitPackGet: RawCaller

vaultsScan: ServerCaller<AgentRPCRequestParams, AgentRPCResponseResult<nodes.agent.types.VaultsScanMessage>>

Readonly validatedNodeId

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

destroy

Parameters

`Optional` hostname?: Hostname

`Optional` quicClient?: QUICClient

`Readonly` [initLock]

`Readonly` certChain

`Readonly` connectionId

`Readonly` host

`Optional` `Readonly` hostname

`Readonly` localHost

`Readonly` localPort

`Protected` logger

`Readonly` nodeId

`Readonly` port

`Readonly` quicClient

`Readonly` quicConnection

`Readonly` rpcClient

nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
success: true;
}>>

`Readonly` validatedNodeId

`Optional` options: boolean | AddEventListenerOptions

__namedParameters: {
force?: boolean;
} = {}

`Optional` force?: boolean

`Protected` handleEventAll

`Protected` handleEventNodeConnectionClose

`Protected` handleEventNodeConnectionError

`Protected` handleEventQUICClientDestroyed

`Protected` handleEventQUICConnectionStopped

`Protected` handleEventQUICConnectionStream

`Protected` handleEventQUICError

`Optional` options: boolean | EventListenerOptions

`Static` createNodeConnection

`Optional` connectionInitialMaxStreamsBidi?: number

`Optional` connectionInitialMaxStreamsUni?: number

`Optional` connectionKeepAliveIntervalTime?: number

`Optional` connectionKeepAliveTimeoutTime?: number

`Optional` logger?: Logger

nodesClaimNetworkVerify: UnaryCaller<AgentRPCRequestParams<AgentClaimMessage>, AgentRPCResponseResult<{
success: true;
}>>

`Optional` quicSocket?: QUICSocket