Class NetworkConnection

Implements

INetworkConnection

Constructors

constructor

new NetworkConnection(context): NetworkConnection
Parameters
- context: Context
Returns NetworkConnection

Accessors

allowEditing

get allowEditing(): boolean
Returns boolean

connectionId

get connectionId(): string
Returns string

currentLatency

get currentLatency(): number
Returns number

currentRoomName

get currentRoomName(): string
Returns string

currentRoomViewId

get currentRoomViewId(): string
Returns string

isConnected

get isConnected(): boolean
Returns boolean
Implementation of INetworkConnection.isConnected

isDebugEnabled

get isDebugEnabled(): boolean
Returns boolean

isInRoom

get isInRoom(): boolean
Returns boolean

peer

get peer(): PeerNetworking
Experimental: networking via peerjs

Returns PeerNetworking

Methods

beginListen

beginListen(key, callback): Function
Parameters
- key: string
- callback: Function
Returns Function

beginListenBinary

beginListenBinary(identifier, callback): BinaryCallback
Parameters
- identifier: string
- callback: BinaryCallback
Returns BinaryCallback

connect

connect(): Promise<boolean>
Returns Promise<boolean>

disconnect

disconnect(): void
Returns void

joinRoom

joinRoom(room, viewOnly?): boolean
Parameters
- room: string
- viewOnly: boolean = false
Returns boolean

leaveRoom

leaveRoom(room?): boolean
Parameters
- room: string = null
Returns boolean

registerProvider

registerProvider(prov): void
Parameters
- prov: INetworkingWebsocketUrlProvider
Returns void

send

send<T>(key, data?, queue?): void
Type Parameters
- T extends WebsocketSendType
Parameters
- key: string
- data: T = null
- queue: SendQueue = SendQueue.Queued
Returns void
Implementation of INetworkConnection.send

sendBinary

sendBinary(bin): void
Parameters
- bin: Uint8Array
Returns void

sendBufferedMessagesNow

sendBufferedMessagesNow(): void
Returns void

sendDeleteRemoteState

sendDeleteRemoteState(guid): void
Parameters
- guid: string
Returns void

sendDeleteRemoteStateAll

sendDeleteRemoteStateAll(): void
Returns void

sendPing

sendPing(): void
Returns void

stopListen

stopListen(key, callback): void
Parameters
- key: string
- callback: Function
Returns void

stopListenBinary

stopListenBinary(identifier, callback): void
Parameters
- identifier: string
- callback: any
Returns void

stopListening

stopListening(key, callback): void
Parameters
- key: string
- callback: Function
Returns void
Deprecated
please use stopListen instead (2.65.2-pre)

tryGetState

tryGetState(guid): IModel
Parameters
- guid: string
Returns IModel

userIsInRoom

userIsInRoom(id): boolean
Parameters
- id: string
Returns boolean

usersInRoom

usersInRoom(target?): string[]
Parameters
- target: string[] = null
Returns string[]

Generated using TypeDoc