Class PingPlugin

Hierarchy (View Summary, Expand)

default
- PingPlugin

Index

Constructors

Properties

Methods

attachedToConnection disable enable transformIncomingEvent transformOutgoingEvent

Constructors

constructor

new PingPlugin(pingInterval: number, roundTripTime?: number): PingPlugin
Parameters
- pingInterval: number
- roundTripTime: number = 2000
Returns PingPlugin
Overrides default.constructor
- Defined in misc/Connection/plugins/PingPongPlugin.ts:44

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

disable

disable(): Promise<void>
Returns Promise<void>
- Defined in misc/Connection/plugins/PingPongPlugin.ts:103

enable

enable(): void
Returns void
- Defined in misc/Connection/plugins/PingPongPlugin.ts:98

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/PingPongPlugin.ts:68

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/PingPongPlugin.ts:94