Interface IConnection

Hierarchy

  • IConnection

Implemented by

Properties

buffer? bufferOffset? bufferPacketId? clientSecret isConnected isLocalPlayer lastPacketNumberReceived? lastPacketNumberSent? matchmakingIdentifier maxMessageSize name pid? playerIdentifier playerSteamId

Methods

addConnectionTimeout addKeepAliveTimeout addTimeout clearQueuedPackets clearTimeout close getState processMatchmakingMessage processQueuedPackets queuePacket send sendKeepAlive sendPacket setState

Properties

Optional buffer

buffer?: Uint8Array

Optional bufferOffset

bufferOffset?: number

Optional bufferPacketId

bufferPacketId?: number

clientSecret

clientSecret: string

Readonly isConnected

isConnected: boolean

Readonly isLocalPlayer

isLocalPlayer: boolean

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

  • Returns void

addKeepAliveTimeout

  • Returns void

addTimeout

  • Parameters

    • milliseconds: number
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

clearQueuedPackets

  • Clears queued packets

    Returns void

clearTimeout

  • Returns boolean

close

  • Parameters

    • closeImmediately: boolean

    Returns void

getState

processMatchmakingMessage

  • Parameters

    Returns Promise<boolean>

processQueuedPackets

  • Sends queued packets w/ flow control

    Returns void

queuePacket

  • Queues a packet to be sent soon Note: packets are serialized when queued

    Parameters

    Returns void

send

  • 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

sendKeepAlive

  • Returns void

sendPacket

  • Sends a packet to the connection w/ flow control

    Parameters

    Returns void

setState

Settings

Member Visibility

Theme

Generated using TypeDoc