Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConnection

Hierarchy

  • IConnection

Implemented by

Index

Properties

Optional buffer

buffer: Uint8Array

Optional bufferOffset

bufferOffset: undefined | number

Optional bufferPacketId

bufferPacketId: undefined | number

Optional lastPacketNumberReceived

lastPacketNumberReceived: undefined | number

Optional lastPacketNumberSent

lastPacketNumberSent: undefined | number

matchmakingIdentifier

matchmakingIdentifier: string

name

name: string

Optional pid

pid: undefined | number

playerIdentifier

playerIdentifier: string | undefined

playerSteamId

playerSteamId: string | undefined

Methods

addConnectionTimeout

  • addConnectionTimeout(): void
  • Returns void

addKeepAliveTimeout

  • addKeepAliveTimeout(): void
  • Returns void

addTimeout

  • addTimeout(milliseconds: number, callback: () => void): void
  • Parameters

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

    Returns void

clearQueuedPackets

  • clearQueuedPackets(): void
  • Clears queued packets

    Returns void

clearTimeout

  • clearTimeout(): boolean
  • Returns boolean

close

  • close(): void
  • Returns void

getState

  • Returns ConnectionState

isConnected

  • isConnected(): boolean
  • Returns boolean

processMatchmakingMessage

processQueuedPackets

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

    Returns void

queuePacket

  • queuePacket(packet: IPacket): void
  • Queues a packet to be sent soon Note: packets are serialized when queued

    Parameters

    Returns void

send

  • send(data: ArrayBuffer | Uint8Array): void
  • Parameters

    • data: ArrayBuffer | Uint8Array

    Returns void

sendKeepAlive

  • sendKeepAlive(): void
  • Returns void

sendPacket

  • sendPacket(packet: IPacket): void
  • Sends a packet to the connection w/ flow control

    Parameters

    Returns void

setState

  • Parameters

    Returns void

Generated using TypeDoc