Room

Index

Properties

• downloadSampleSize
• latencySampleSize
• pingDelay
• uploadSampleSize

Accessors

• averageBytesDownloadedPerSecond
• averageBytesUploadedPerSecond
• averageLatency
• bytesDownloadedSinceLastSecond
• bytesUploadedSinceLastSecond
• closeReason
• currentLatency
• id
• localClientId
• totalBytesDownloaded
• totalBytesUploaded

Methods

• onClose
• onError
• onMessage
• send

Properties

downloadSampleSize

downloadSampleSize: number = 10

Last N seconds to use when calculating average bytes downloaded per second.

latencySampleSize

latencySampleSize: number = 10

The number of samples to use when calculating average latency.

pingDelay

pingDelay: number = 5000

The number of milliseconds to wait before sending a ping packet.

uploadSampleSize

uploadSampleSize: number = 10

Last N seconds to use when calculating average bytes uploaded per second.

Accessors

averageBytesDownloadedPerSecond

• get averageBytesDownloadedPerSecond(): number

• Returns the average bytes downloaded per second over the last N seconds.

  ---

  Returns number

averageBytesUploadedPerSecond

• get averageBytesUploadedPerSecond(): number

• Returns the average bytes uploaded per second over the last N seconds.

  ---

  Returns number

averageLatency

• get averageLatency(): number

• Returns the average latency over the last N seconds.

  ---

  Returns number

bytesDownloadedSinceLastSecond

• get bytesDownloadedSinceLastSecond(): number

• Returns the number of bytes downloaded in the last second.

  ---

  Returns number

bytesUploadedSinceLastSecond

• get bytesUploadedSinceLastSecond(): number

• Returns the number of bytes uploaded in the last second.

  ---

  Returns number

closeReason

• get closeReason(): string

• Returns the reason for the connection being closed.

  ---

  Returns string

currentLatency

• get currentLatency(): number

• Latest recorded latency sample in milliseconds.

  ---

  Returns number

id

• get id(): string

• Returns the ID of the room.

  ---

  Returns string

localClientId

• get localClientId(): number

• Returns the ID of the local client.

  ---

  Returns number

totalBytesDownloaded

• get totalBytesDownloaded(): number

• Returns the total number of bytes downloaded since the connection was established.

  ---

  Returns number

totalBytesUploaded

• get totalBytesUploaded(): number

• Returns the total number of bytes uploaded since the connection was established.

  ---

  Returns number

Methods

onClose

• onClose(callback: (e: Event) => void): void

• Registers a handler for when the connection is closed.

  ---

  Parameters

  • callback: (e: Event) => void

    The callback function that will be called when the connection is closed.

  Returns void

onError

• onError(callback: (error: string) => void): void

• Registers a handler for when the server sends an error.

  ---

  Parameters

  • callback: (error: string) => void

    The callback function that will be called when the server sends an error.

  Returns void

onMessage

• onMessage(event: string | number, handler: MessageHandler): void

• Registers a handler for event

  ---

  Parameters

  • event: string | number

    Unique identifier for this event.

    Using a string for event ids is not recommended as it makes the network packet considerably bigger (2 bytes for length and an extra 2 bytes for every character in string).

    You may use any number from 0 to 255.

  • handler: MessageHandler

    The MessageHandler function that will be called when this event is received.

  Returns void

send

• send(event: string | number, message: string | number | object | Buffer): void

• Sends a message to the server.

  ---

  Parameters

  • event: string | number

    Unique identifier for this event.

  • message: string | number | object | Buffer

    The message to send.

  Returns void