Class NodesHolePunchMessageSend

Sends a hole punch message to a node

Hierarchy

UnaryHandler<{
    db: DB;
    keyRing: KeyRing;
    logger: Logger;
    nodeConnectionManager: NodeConnectionManager;
    nodeManager: NodeManager;
}, AgentRPCRequestParams<HolePunchRelayMessage>, AgentRPCResponseResult>
- NodesHolePunchMessageSend

Index

Constructors

constructor

new NodesHolePunchMessageSend(container): NodesHolePunchMessageSend
Parameters
- container: {
      db: DB;
      keyRing: KeyRing;
      logger: Logger;
      nodeConnectionManager: NodeConnectionManager;
      nodeManager: NodeManager;
  }
  - db: DB
  - keyRing: KeyRing
  - logger: Logger
  - nodeConnectionManager: NodeConnectionManager
  - nodeManager: NodeManager
Returns NodesHolePunchMessageSend
Inherited from UnaryHandler< { db: DB; nodeConnectionManager: NodeConnectionManager; keyRing: KeyRing; nodeManager: NodeManager; logger: Logger; }, AgentRPCRequestParams<HolePunchRelayMessage>, AgentRPCResponseResult >.constructor
- Defined in node_modules/@matrixai/rpc/dist/handlers/Handler.d.ts:11

Properties

`Protected` _inputType

_inputType: AgentRPCRequestParams<HolePunchRelayMessage>

`Protected` _outputType

_outputType: AgentRPCResponseResult

`Protected` container

container: {
    db: DB;
    keyRing: KeyRing;
    logger: Logger;
    nodeConnectionManager: NodeConnectionManager;
    nodeManager: NodeManager;
}

Type declaration

db: DB
keyRing: KeyRing
logger: Logger
nodeConnectionManager: NodeConnectionManager
nodeManager: NodeManager

`Optional` timeout

timeout?: number

This is the timeout used for the handler. If it is not set then the default timeout time for the RPCServer is used.

Methods

handle

handle(input, _cancel, meta): Promise<AgentRPCResponseResult>
Parameters
- input: AgentRPCRequestParams<HolePunchRelayMessage>
- _cancel: any
- meta: any
Returns Promise<AgentRPCResponseResult>
Overrides UnaryHandler.handle
- Defined in src/nodes/agent/handlers/NodesHolePunchMessageSend.ts:35

Class NodesHolePunchMessageSend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

container: {
    db: DB;
    keyRing: KeyRing;
    logger: Logger;
    nodeConnectionManager: NodeConnectionManager;
    nodeManager: NodeManager;
}

db: DB

keyRing: KeyRing

logger: Logger

nodeConnectionManager: NodeConnectionManager

nodeManager: NodeManager

Returns NodesHolePunchMessageSend

Properties

`Protected` _inputType

`Protected` _outputType

`Protected` container

Type declaration

db: DB

keyRing: KeyRing

logger: Logger

nodeConnectionManager: NodeConnectionManager

nodeManager: NodeManager

`Optional` timeout

Methods

handle

Parameters

input: AgentRPCRequestParams<HolePunchRelayMessage>

_cancel: any

meta: any

Returns Promise<AgentRPCResponseResult>

Settings

Member Visibility

Theme

On This Page

Class NodesHolePunchMessageSend

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

container: { db: DB; keyRing: KeyRing; logger: Logger; nodeConnectionManager: NodeConnectionManager; nodeManager: NodeManager; }

db: DB

keyRing: KeyRing

logger: Logger

nodeConnectionManager: NodeConnectionManager

nodeManager: NodeManager

Returns NodesHolePunchMessageSend

Properties

Protected _inputType

Protected _outputType

Protected container

Type declaration

db: DB

keyRing: KeyRing

logger: Logger

nodeConnectionManager: NodeConnectionManager

nodeManager: NodeManager

Optional timeout

Methods

handle

Parameters

input: AgentRPCRequestParams<HolePunchRelayMessage>

_cancel: any

meta: any

Returns Promise<AgentRPCResponseResult>

Settings

Member Visibility

Theme

On This Page

container: {
db: DB;
keyRing: KeyRing;
logger: Logger;
nodeConnectionManager: NodeConnectionManager;
nodeManager: NodeManager;
}

`Protected` _inputType

`Protected` _outputType

`Protected` container

`Optional` timeout