Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

Methods

attachedToConnection cleanup transformIncomingEvent transformOutgoingEvent waitForBinaryMessage waitForJSONMessage waitForJSONMessageWithType waitForMessage waitForStringMessage

Constructors

constructor

new default(maxDataQueueSize?: number, defaultReadTimeout?: number): default
Parameters
- maxDataQueueSize: number = 10
- defaultReadTimeout: number = Number.POSITIVE_INFINITY
Returns default
Overrides default.constructor
- Defined in misc/Connection/plugins/PromisePlugin.ts:9

Properties

`Readonly`name

name: string

Methods

attachedToConnection

attachedToConnection(
eventCreationFunctions: EventCreationFunctions,
id: number,
): void
This function is called when a plugin is attached.
Parameters
- eventCreationFunctions: EventCreationFunctions
- id: number
Returns void
Inherited from default.attachedToConnection
- Defined in misc/Connection/ConnectionPlugin.ts:64

cleanup

cleanup(reason?: string): void
Parameters
- Optionalreason: string
Returns void
- Defined in misc/Connection/plugins/PromisePlugin.ts:31

transformIncomingEvent

transformIncomingEvent(
event: ConnectionIncomingEvent,
): null | ConnectionIncomingEvent
This function is called when a message is received.
Parameters
- event: ConnectionIncomingEvent
Returns null | ConnectionIncomingEvent
- The message that will be received by the app.
Overrides default.transformIncomingEvent
- Defined in misc/Connection/plugins/PromisePlugin.ts:18

transformOutgoingEvent

transformOutgoingEvent(
event: ConnectionOutgoingEvent,
): null | ConnectionOutgoingEvent
This function is called when a message is sent.
Parameters
- event: ConnectionOutgoingEvent
Returns null | ConnectionOutgoingEvent
- The message that will be sent.
Overrides default.transformOutgoingEvent
- Defined in misc/Connection/plugins/PromisePlugin.ts:27

waitForBinaryMessage

waitForBinaryMessage(timeout?: number): Promise<Uint8Array<ArrayBufferLike>>
Wait for a binary message.
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<Uint8Array<ArrayBufferLike>>
The promise will resolve when a value was received. The promise will reject when 1) the timeout expired 2) the connection was closed
- Defined in misc/Connection/plugins/PromisePlugin.ts:106

waitForJSONMessage

waitForJSONMessage(timeout?: number): Promise<any>
Wait for an incoming message for a specified period of time.
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<any>
The promise will resolve when a value was received. The value will be the JSON.parsed object. The promise will reject when 1) the timeout expired 2) the connection was closed
- Defined in misc/Connection/plugins/PromisePlugin.ts:86

waitForJSONMessageWithType

waitForJSONMessageWithType(
    type: string,
    typekey?: string,
    timeout?: number,
): Promise<any>
Wait for an incoming message with a specific type for a specified period of time.
Parameters
- type: string
  The type field of the message should have this type.
- typekey: string = 'type'
  The name of the member that holds the type that is checked for equality with the type param.
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<any>
The promise will resolve when a value was received. The value will be the JSON.parse'd object The promise will reject when 1) the timeout expired 2) the connection was closed 3) the type of the received message doe not match parameter 'type'
- Defined in misc/Connection/plugins/PromisePlugin.ts:53

waitForMessage

waitForMessage(timeout?: number): Promise<string | Uint8Array<ArrayBufferLike>>
Wait for an incoming message for a specified period of time.
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<string | Uint8Array<ArrayBufferLike>>
The promise will resolve when a value was received. The promise will reject when 1) the timeout expired 2) the connection was closed
- Defined in misc/Connection/plugins/PromisePlugin.ts:142

waitForStringMessage

waitForStringMessage(timeout?: number): Promise<string>
Wait for a string based message.
Parameters
- Optionaltimeout: number
  Timeout as unsigned 32-bit integer or Number.POSITIVE_INFINITY. If undefined use the default value passed to the constructor.
Returns Promise<string>
The promise will resolve when a value was received. The promise will reject when 1) the timeout expired 2) the connection was closed
- Defined in misc/Connection/plugins/PromisePlugin.ts:124

Class default

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Readonlyname

Methods

attachedToConnection

Parameters

Returns void

cleanup

Parameters

Returns void

transformIncomingEvent

Parameters

Returns null | ConnectionIncomingEvent

transformOutgoingEvent

Parameters

Returns null | ConnectionOutgoingEvent

waitForBinaryMessage

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

waitForJSONMessage

Parameters

Returns Promise<any>

waitForJSONMessageWithType

Parameters

Returns Promise<any>

waitForMessage

Parameters

Returns Promise<string | Uint8Array<ArrayBufferLike>>

waitForStringMessage

Parameters

Returns Promise<string>

Settings

On This Page

`Readonly`name