Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetworkClient

Hierarchy

  • NetworkClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • new NetworkClient(classRegistry: ClassRegistry<Serializable>): NetworkClient

Properties

Private Optional assignedPlayerId

assignedPlayerId: PlayerId

Private Optional handshakeFulfillment

handshakeFulfillment: { reject: (reason?: any) => void; resolve: (value?: void | PromiseLike<void>) => void }

Type declaration

  • reject: (reason?: any) => void
      • (reason?: any): void

      • Parameters

        • Optional reason: any

        Returns void

  • resolve: (value?: void | PromiseLike<void>) => void
      • (value?: void | PromiseLike<void>): void

      • Parameters

        • Optional value: void | PromiseLike<void>

        Returns void

isConnected

isConnected: boolean = false

Private messageRouter

messageRouter: MessageRouter = ...

Private Optional networkPeer

networkPeer: NetworkPeer

onConnected

onConnected: SyncEvent<PlayerId> = ...

onDisconnected

onDisconnected: VoidSyncEvent = ...

Methods

close

  • close(): void

connect

  • connect(serverWsUrl: string): Promise<void>

Private connectToRTCServer

  • connectToRTCServer(serverWsUrl: string): Promise<NetworkPeerAndPlayerId>

flushMessagesToNetwork

  • flushMessagesToNetwork(): void

Private handleDisconnect

  • handleDisconnect(): void

registerMessageHandler

  • registerMessageHandler<T>(ctor: new (...args: any[]) => T, handler: (t: T) => void): void

  • Type parameters

    • T: Serializable

    Parameters

    • ctor: new (...args: any[]) => T
        • new (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • handler: (t: T) => void
        • (t: T): void

        • Parameters

          • t: T

          Returns void

    Returns void

registerMessageType

  • registerMessageType<T>(ctor: new (...args: any[]) => T, uniqueMessageTypeName: string): void

  • Type parameters

    • T: Serializable

    Parameters

    • ctor: new (...args: any[]) => T
        • new (...args: any[]): T

        • Parameters

          • Rest ...args: any[]

          Returns T

    • uniqueMessageTypeName: string

    Returns void

sendMessage

  • sendMessage(message: Serializable, onAck?: () => void): undefined | OutboundMessage

  • Places messages in to the outbound queue. Actual network send is done by flushMessagesToNetwork. Messages are unordered, prioritized individually, and can be given a TTL / marked expired to limit reliability.

    Parameters

    • message: Serializable
    • Optional onAck: () => void
        • (): void

        • Returns void

    Returns undefined | OutboundMessage

Generated using TypeDoc