Class Connection`Abstract`

Hierarchy

Connection

Implements

IConnection

Constructors

constructor

new Connection(matchmakingInfo: undefined | IMatchmakingInfo, log: default): Connection
Parameters
- matchmakingInfo: undefined | IMatchmakingInfo
- log: default
Returns Connection
- Defined in src/game/multiplayer/networking/Connection.ts:58

Properties

`Protected` _matchmakingInfo

_matchmakingInfo: undefined | IMatchmakingInfo

`Optional` buffer

buffer?: Uint8Array

`Optional` bufferOffset

bufferOffset?: number

`Optional` bufferPacketId

bufferPacketId?: number

clientSecret

clientSecret: string

`Optional` lastPacketNumberReceived

lastPacketNumberReceived?: number

`Optional` lastPacketNumberSent

lastPacketNumberSent?: number

`Protected` `Readonly` log

matchmakingIdentifier

matchmakingIdentifier: string

`Readonly` `Abstract` maxMessageSize

maxMessageSize: number

`Abstract` name

name: string

`Optional` pid

pid?: number

playerIdentifier

playerIdentifier: undefined | string

playerSteamId

playerSteamId: undefined | string

Methods

`Protected` _clearKeepAliveInterval

_clearKeepAliveInterval(): void
Returns void
- Defined in src/game/multiplayer/networking/Connection.ts:373

addConnectionTimeout

addConnectionTimeout(): void
Returns void
Implementation of IConnection.addConnectionTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:98

addKeepAliveTimeout

addKeepAliveTimeout(): void
Returns void
Implementation of IConnection.addKeepAliveTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:105

addTimeout

addTimeout(milliseconds: number, callback: (() => void)): void
Parameters
- milliseconds: number
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Implementation of IConnection.addTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:122

clearQueuedPackets

clearQueuedPackets(): void
Clears queued packets

Returns void
Implementation of IConnection.clearQueuedPackets
- Defined in src/game/multiplayer/networking/Connection.ts:207

clearTimeout

clearTimeout(): boolean
Returns boolean
Implementation of IConnection.clearTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:131

close

close(closeImmediately: boolean): void
Parameters
- closeImmediately: boolean
Returns void
Implementation of IConnection.close
- Defined in src/game/multiplayer/networking/Connection.ts:65

getState

getState(): ConnectionState
Returns ConnectionState
Implementation of IConnection.getState
- Defined in src/game/multiplayer/networking/Connection.ts:160

`Abstract` isConnected

isConnected(): boolean
Returns boolean
Implementation of IConnection.isConnected
- Defined in src/game/multiplayer/networking/Connection.ts:367

`Protected` `Abstract` onClosed

onClosed(): void
Returns void
- Defined in src/game/multiplayer/networking/Connection.ts:369

`Protected` `Abstract` onClosing

onClosing(): void
Returns void
- Defined in src/game/multiplayer/networking/Connection.ts:368

`Abstract` processMatchmakingMessage

processMatchmakingMessage(message: MatchmakingMessageData): Promise<boolean>
Parameters
- message: MatchmakingMessageData
Returns Promise<boolean>
Implementation of IConnection.processMatchmakingMessage
- Defined in src/game/multiplayer/networking/Connection.ts:371

processQueuedPackets

processQueuedPackets(): void
Sends queued packets w/ flow control

Returns void
Implementation of IConnection.processQueuedPackets
- Defined in src/game/multiplayer/networking/Connection.ts:231

queuePacket

queuePacket(packet: IPacket<any>): void
Queues a packet to be sent soon Note: packets are serialized when queued
Parameters
- packet: IPacket<any>
Returns void
Implementation of IConnection.queuePacket
- Defined in src/game/multiplayer/networking/Connection.ts:180

`Protected` queuePacketData

queuePacketData(data: ArrayBuffer, packetNumber?: number): void
Queues data to be sent soon
Parameters
- data: ArrayBuffer
- Optional packetNumber: number
Returns void
- Defined in src/game/multiplayer/networking/Connection.ts:194

`Abstract` send

send(data: Uint8Array, byteOffset: number, length?: number): boolean
Sends data to the connection

Returns
True when sent, false when it was not sent and should be retried. Throws an error if something very bad happened
Parameters
- data: Uint8Array
  
  Data to send
- byteOffset: number
- Optional length: number
Returns boolean
Implementation of IConnection.send
- Defined in src/game/multiplayer/networking/Connection.ts:370

sendKeepAlive

sendKeepAlive(): void
Sends a ping packet to the server every so often. The server should send back a pong packet.

Returns void
Implementation of IConnection.sendKeepAlive
- Defined in src/game/multiplayer/networking/Connection.ts:146

sendPacket

sendPacket(packet: IPacket<any>): void
Sends a packet to the connection w/ flow control
Parameters
- packet: IPacket<any>
Returns void
Implementation of IConnection.sendPacket
- Defined in src/game/multiplayer/networking/Connection.ts:214

setState

setState(state: ConnectionState): void
Parameters
- state: ConnectionState
Returns void
Implementation of IConnection.setState
- Defined in src/game/multiplayer/networking/Connection.ts:164

Generated using TypeDoc