Class SteamNetworkConnection

Hierarchy

Connection
- SteamNetworkConnection

Constructors

constructor

new SteamNetworkConnection(steamNetworking: ISteamworksNetworking, hostSteamId: string, matchmakingInfo: undefined | IMatchmakingInfo, matchmakingIdentifier: string, onData: ((data: ArrayBuffer) => void), onConnected?: ((matchmakingInfo: IMatchmakingInfo) => void), connectGlobalMatchmakingServer?: (() => void)): SteamNetworkConnection
Parameters
- steamNetworking: ISteamworksNetworking
- hostSteamId: string
- matchmakingInfo: undefined | IMatchmakingInfo
- matchmakingIdentifier: string
- onData: ((data: ArrayBuffer) => void)
  - - (data: ArrayBuffer): void
    - Parameters
      
      data: ArrayBuffer
      
      Returns void
- Optional onConnected: ((matchmakingInfo: IMatchmakingInfo) => void)
  - - (matchmakingInfo: IMatchmakingInfo): void
    - Parameters
      
      matchmakingInfo: IMatchmakingInfo
      
      Returns void
- Optional connectGlobalMatchmakingServer: (() => void)
  - - (): void
    - Returns void
Returns SteamNetworkConnection
Overrides Connection.constructor
- Defined in src/game/multiplayer/networking/SteamNetworkConnection.ts:36

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

matchmakingIdentifier

matchmakingIdentifier: string

`Readonly` maxMessageSize

maxMessageSize: 65536 = 65536

name

name: string = "SteamNetworkConnection"

`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/SteamNetworkConnection.ts:100

isLocalPlayer

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

steamIdRemote

get steamIdRemote(): undefined | string
Steam id of the peer

Returns undefined | string
- Defined in src/game/multiplayer/networking/SteamNetworkConnection.ts:77

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

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

close

close(closeImmediately: boolean): void
Parameters
- closeImmediately: boolean
Returns void
Inherited from Connection.close
- Defined in src/game/multiplayer/networking/Connection.ts:69

getState

getState(): ConnectionState
Returns ConnectionState
Inherited from Connection.getState
- Defined in src/game/multiplayer/networking/Connection.ts:164

`Protected` onClosed

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

`Protected` onClosing

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

processMatchmakingMessage

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

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 | ArrayBuffer): 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 | ArrayBuffer
  
  Data to send
Returns boolean
Overrides Connection.send
- Defined in src/game/multiplayer/networking/SteamNetworkConnection.ts:105

sendKeepAlive

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

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

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

Generated using TypeDoc