Class SmartConnection

Connects to the host either using Steam Networking, WebRTC, or WebSockets (in that order)

Hierarchy

Connection
- SmartConnection

Constructors

constructor

new SmartConnection(matchmakingInfo: IMatchmakingInfo, matchmakingIdentifier: string, webRTCConfig: RTCConfiguration, sendMatchmakingMessage: ((message: MatchmakingMessageData) => void), onData: ((data: ArrayBuffer) => void), onConnected: ((matchmakingInfo: IMatchmakingInfo) => void), trySteamRelayNetwork: boolean, connectGlobalMatchmakingServer: (() => void)): SmartConnection
Parameters
- matchmakingInfo: IMatchmakingInfo
- matchmakingIdentifier: string
- webRTCConfig: RTCConfiguration
- sendMatchmakingMessage: ((message: MatchmakingMessageData) => void)
  - - (message: MatchmakingMessageData): void
    - Parameters
      
      message: MatchmakingMessageData
      
      Returns void
- onData: ((data: ArrayBuffer) => void)
  - - (data: ArrayBuffer): void
    - Parameters
      
      data: ArrayBuffer
      
      Returns void
- onConnected: ((matchmakingInfo: IMatchmakingInfo) => void)
  - - (matchmakingInfo: IMatchmakingInfo): void
    - Parameters
      
      matchmakingInfo: IMatchmakingInfo
      
      Returns void
- trySteamRelayNetwork: boolean
- connectGlobalMatchmakingServer: (() => void)
  - - (): void
    - Returns void
Returns SmartConnection
Overrides Connection.constructor
- Defined in src/game/multiplayer/networking/SmartConnection.ts:40

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

log: Log

`Readonly` matchmakingIdentifier

matchmakingIdentifier: string

name

name: string = "SmartConnection"

`Optional` pid

pid?: number

playerIdentifier

playerIdentifier: undefined | string

playerSteamId

playerSteamId: undefined | string

Accessors

isConnected

get isConnected(): boolean
Returns boolean
Overrides Connection.isConnected
- Defined in src/game/multiplayer/networking/SmartConnection.ts:74

isLocalPlayer

get isLocalPlayer(): boolean
Returns boolean
Inherited from Connection.isLocalPlayer
- Defined in src/game/multiplayer/networking/Connection.ts:65

isSteamNetworkConnection

get isSteamNetworkConnection(): boolean
Returns boolean
- Defined in src/game/multiplayer/networking/SmartConnection.ts:70

maxMessageSize

get maxMessageSize(): number
Returns number
Overrides Connection.maxMessageSize
- Defined in src/game/multiplayer/networking/SmartConnection.ts:86

Methods

`Protected` _clearKeepAliveInterval

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

addConnectionTimeout

addConnectionTimeout(): void
Returns void
Inherited from Connection.addConnectionTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:102

addKeepAliveTimeout

addKeepAliveTimeout(): void
Returns void
Overrides Connection.addKeepAliveTimeout
- Defined in src/game/multiplayer/networking/SmartConnection.ts:125

addTimeout

addTimeout(milliseconds: number, callback: (() => void)): void
Parameters
- milliseconds: number
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Connection.addTimeout
- Defined in src/game/multiplayer/networking/Connection.ts:126

clearQueuedPackets

clearQueuedPackets(): void
Clears queued packets

Returns void
Inherited from Connection.clearQueuedPackets
- Defined in src/game/multiplayer/networking/Connection.ts:211

clearTimeout

clearTimeout(): boolean
Returns boolean
Overrides Connection.clearTimeout
- Defined in src/game/multiplayer/networking/SmartConnection.ts:133

close

close(closeImmediately: boolean): void
Parameters
- closeImmediately: boolean
Returns void
Overrides Connection.close
- Defined in src/game/multiplayer/networking/SmartConnection.ts:91

getState

getState(): ConnectionState
Returns ConnectionState
Overrides Connection.getState
- Defined in src/game/multiplayer/networking/SmartConnection.ts:78

`Protected` onClosed

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

`Protected` onClosing

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

processMatchmakingMessage

processMatchmakingMessage(message: MatchmakingMessageData): Promise<boolean>
Parameters
- message: MatchmakingMessageData
Returns Promise<boolean>
Overrides Connection.processMatchmakingMessage
- Defined in src/game/multiplayer/networking/SmartConnection.ts:153

processQueuedPackets

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

Returns void
Inherited from Connection.processQueuedPackets
- Defined in src/game/multiplayer/networking/Connection.ts:235

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
Inherited from Connection.queuePacket
- Defined in src/game/multiplayer/networking/Connection.ts:184

`Protected` queuePacketData

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

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
Overrides Connection.send
- Defined in src/game/multiplayer/networking/SmartConnection.ts:137

sendKeepAlive

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

Returns void
Overrides Connection.sendKeepAlive
- Defined in src/game/multiplayer/networking/SmartConnection.ts:129

sendPacket

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

setState

setState(state: ConnectionState): void
Parameters
- state: ConnectionState
Returns void
Overrides Connection.setState
- Defined in src/game/multiplayer/networking/SmartConnection.ts:82

Class SmartConnection

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

matchmakingInfo: IMatchmakingInfo

matchmakingIdentifier: string

webRTCConfig: RTCConfiguration

sendMatchmakingMessage: ((message: MatchmakingMessageData) => void)

Parameters

message: MatchmakingMessageData

Returns void

onData: ((data: ArrayBuffer) => void)

Parameters

data: ArrayBuffer

Returns void

onConnected: ((matchmakingInfo: IMatchmakingInfo) => void)

Parameters

matchmakingInfo: IMatchmakingInfo

Returns void

trySteamRelayNetwork: boolean

connectGlobalMatchmakingServer: (() => void)

Returns void

Returns SmartConnection

Properties

Protected _matchmakingInfo

Optional buffer

Optional bufferOffset

Optional bufferPacketId

clientSecret

Optional lastPacketNumberReceived

Optional lastPacketNumberSent

Protected Readonly log

Readonly matchmakingIdentifier

name

Optional pid

playerIdentifier

playerSteamId

Accessors

isConnected

Returns boolean

isLocalPlayer

Returns boolean

isSteamNetworkConnection

Returns boolean

maxMessageSize

Returns number

Methods

Protected _clearKeepAliveInterval

Returns void

addConnectionTimeout

Returns void

addKeepAliveTimeout

Returns void

addTimeout

Parameters

milliseconds: number

callback: (() => void)

Returns void

Returns void

clearQueuedPackets

Returns void

clearTimeout

Returns boolean

close

Parameters

closeImmediately: boolean

Returns void

getState

Returns ConnectionState

Protected onClosed

Returns void

Protected onClosing

Returns void

processMatchmakingMessage

`Protected` _matchmakingInfo

`Optional` buffer

`Optional` bufferOffset

`Optional` bufferPacketId

`Optional` lastPacketNumberReceived

`Optional` lastPacketNumberSent

`Protected` `Readonly` log

`Readonly` matchmakingIdentifier

`Optional` pid

`Protected` _clearKeepAliveInterval

`Protected` onClosed

`Protected` onClosing

`Protected` queuePacketData

`Optional` packetNumber: number

`Optional` length: number