Class ConnectionAbstract

Hierarchy

Implements

Constructors

constructor

Properties

_matchmakingInfo buffer? bufferOffset? bufferPacketId? clientSecret lastPacketNumberReceived? lastPacketNumberSent? log matchmakingIdentifier maxMessageSize name pid? playerIdentifier playerSteamId

Accessors

isConnected isLocalPlayer

Methods

_clearKeepAliveInterval addConnectionTimeout addKeepAliveTimeout addTimeout clearQueuedPackets clearTimeout close getState onClosed onClosing processMatchmakingMessage processQueuedPackets queuePacket queuePacketData send sendKeepAlive sendPacket setState

Constructors

constructor

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 Abstract maxMessageSize

maxMessageSize: number

Abstract name

name: string

Optional pid

pid?: number

playerIdentifier

playerIdentifier: undefined | string

playerSteamId

playerSteamId: undefined | string

Accessors

Abstract isConnected

  • get isConnected(): boolean

  • Returns boolean

isLocalPlayer

  • get isLocalPlayer(): boolean

  • Returns boolean

Methods

Protected _clearKeepAliveInterval

  • _clearKeepAliveInterval(): void

  • Returns void

addConnectionTimeout

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

Protected Abstract onClosed

  • Returns void

Protected Abstract onClosing

  • Returns void

Abstract processMatchmakingMessage

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

Protected queuePacketData

  • Queues data to be sent soon

    Parameters

    • data: ArrayBuffer
    • Optional packetNumber: number

    Returns void

Abstract 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

  • Sends a ping packet to the server every so often. The server should send back a pong packet.

    Returns void

sendPacket

  • Sends a packet to the connection w/ flow control

    Parameters

    Returns void

setState

Settings

Member Visibility

Theme

Generated using TypeDoc