Class NetIPCMessage

Hierarchy (view full)

IPCBaseMessage
- NetIPCMessage

Index

Constructors

Properties

data error? instance nonce respond? type

Methods

reply request send toJSON

Constructors

constructor

new NetIPCMessage(instance, message, respond?): NetIPCMessage
Parameters
- instance: ServerClient | ServerClientConnection
- message: IPCRawMessage
- Optional respond: NetIPCMessageRespond
Returns NetIPCMessage
Overrides IPCBaseMessage.constructor
- Defined in src/ipc/IPCMessage.ts:94

Properties

data

data: IPCMessageData

Message data.

`Optional` error

error?: MakeErrorOptions

Message error data.

instance

instance: ServerClient | ServerClientConnection

nonce

nonce: string

Message nonce.

`Optional` respond

respond?: NetIPCMessageRespond

type

type: IPCMessageType

Message type.

Methods

reply

reply(data): Promise<void>
Sends a reply to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:132

request

request(data): Promise<void>
Sends a request to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:119

send

send(data): Promise<void>
Sends a message to instance.
Parameters
- data: IPCMessageData
  Message data.
Returns Promise<void>
- Defined in src/ipc/IPCMessage.ts:106

toJSON

toJSON(): IPCRawMessage
Serializes the message to JSON.

Returns IPCRawMessage
Inherited from IPCBaseMessage.toJSON
- Defined in src/ipc/IPCMessage.ts:39

Generated using TypeDoc