Interface IConnection

Hierarchy

IConnection

Implemented by

Connection

Properties

`Optional` buffer

buffer?: Uint8Array

`Optional` bufferOffset

bufferOffset?: number

`Optional` bufferPacketId

bufferPacketId?: number

clientSecret

clientSecret: string

`Optional` lastPacketNumberReceived

lastPacketNumberReceived?: number

`Optional` lastPacketNumberSent

lastPacketNumberSent?: number

matchmakingIdentifier

matchmakingIdentifier: string

maxMessageSize

maxMessageSize: number

name

name: string

`Optional` pid

pid?: number

playerIdentifier

playerIdentifier: undefined | string

playerSteamId

playerSteamId: undefined | string

Methods

addConnectionTimeout

addConnectionTimeout(): void
Returns void
- Defined in src/game/multiplayer/networking/IConnection.ts:48

addKeepAliveTimeout

addKeepAliveTimeout(): void
Returns void
- Defined in src/game/multiplayer/networking/IConnection.ts:49

addTimeout

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

clearQueuedPackets

clearQueuedPackets(): void
Clears queued packets

Returns void
- Defined in src/game/multiplayer/networking/IConnection.ts:64

clearTimeout

clearTimeout(): boolean
Returns boolean
- Defined in src/game/multiplayer/networking/IConnection.ts:51

close

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

getState

getState(): ConnectionState
Returns ConnectionState
- Defined in src/game/multiplayer/networking/IConnection.ts:44

isConnected

isConnected(): boolean
Returns boolean
- Defined in src/game/multiplayer/networking/IConnection.ts:45

processMatchmakingMessage

processMatchmakingMessage(message: ArrayBuffer | MatchmakingMessageData): Promise<boolean>
Parameters
- message: ArrayBuffer | MatchmakingMessageData
Returns Promise<boolean>
- Defined in src/game/multiplayer/networking/IConnection.ts:53

processQueuedPackets

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

Returns void
- Defined in src/game/multiplayer/networking/IConnection.ts:74

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
- Defined in src/game/multiplayer/networking/IConnection.ts:59

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
- Defined in src/game/multiplayer/networking/IConnection.ts:81

sendKeepAlive

sendKeepAlive(): void
Returns void
- Defined in src/game/multiplayer/networking/IConnection.ts:84

sendPacket

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

setState

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

Generated using TypeDoc