Class KeepAlivePlugin

This plugin generates keep alive pulses and detects if it gets any from the other side.

If nothing is received from the other side for a specified amount of time this class will terminate the connection.

Hierarchy (View Summary)

default
- KeepAlivePlugin

Index

Constructors

Properties

Methods

attachedToConnection disable enable transformIncomingEvent transformOutgoingEvent

Constructors

constructor

new KeepAlivePlugin(
keepaliveTimer: number,
keepaliveTimeout: number,
): KeepAlivePlugin
Parameters
- keepaliveTimer: number
- keepaliveTimeout: number
Returns KeepAlivePlugin
Overrides default.constructor
- Defined in misc/Connection/plugins/KeepAlivePlugin.ts:18

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(): void
Returns void
- Defined in misc/Connection/plugins/KeepAlivePlugin.ts:99

enable

enable(): void
Returns void
- Defined in misc/Connection/plugins/KeepAlivePlugin.ts:94

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/KeepAlivePlugin.ts:40

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/KeepAlivePlugin.ts:73