Class WebSocketAdapterText

A text-based socket adapter that accepts and transmits payloads over UTF-8.

Hierarchy

WebSocketAdapterText

Implements

WebSocketAdapter

Index

Constructors

Properties

Accessors

onClose onError onMessage onOpen

Methods

close connect isOpen send

Constructors

constructor

new WebSocketAdapterText(): WebSocketAdapterText
Returns WebSocketAdapterText

Properties

`Private` `Optional` _socket

_socket?: WebSocket

Accessors

onClose

get onClose(): null | SocketCloseHandler
Dispatched when the web socket closes.

Returns null | SocketCloseHandler
Implementation of WebSocketAdapter.onClose
- Defined in nakama-js/web_socket_adapter.ts:86
set onClose(value: null | SocketCloseHandler): void
Dispatched when the web socket closes.
Parameters
- value: null | SocketCloseHandler
Returns void
Implementation of WebSocketAdapter.onClose
- Defined in nakama-js/web_socket_adapter.ts:90

onError

get onError(): null | SocketErrorHandler
Dispatched when the web socket receives an error.

Returns null | SocketErrorHandler
Implementation of WebSocketAdapter.onError
- Defined in nakama-js/web_socket_adapter.ts:94
set onError(value: null | SocketErrorHandler): void
Dispatched when the web socket receives an error.
Parameters
- value: null | SocketErrorHandler
Returns void
Implementation of WebSocketAdapter.onError
- Defined in nakama-js/web_socket_adapter.ts:98

onMessage

get onMessage(): null | SocketMessageHandler
Dispatched when the web socket receives a normal message.

Returns null | SocketMessageHandler
Implementation of WebSocketAdapter.onMessage
- Defined in nakama-js/web_socket_adapter.ts:102
set onMessage(value: null | SocketMessageHandler): void
Dispatched when the web socket receives a normal message.
Parameters
- value: null | SocketMessageHandler
Returns void
Implementation of WebSocketAdapter.onMessage
- Defined in nakama-js/web_socket_adapter.ts:106

onOpen

get onOpen(): null | SocketOpenHandler
Dispatched when the web socket opens.

Returns null | SocketOpenHandler
Implementation of WebSocketAdapter.onOpen
- Defined in nakama-js/web_socket_adapter.ts:125
set onOpen(value: null | SocketOpenHandler): void
Dispatched when the web socket opens.
Parameters
- value: null | SocketOpenHandler
Returns void
Implementation of WebSocketAdapter.onOpen
- Defined in nakama-js/web_socket_adapter.ts:129

Methods

close

close(): void
Returns void
Implementation of WebSocketAdapter.close
- Defined in nakama-js/web_socket_adapter.ts:142

connect

connect(scheme: string, host: string, port: string, createStatus: boolean, token: string): void
Parameters
- scheme: string
- host: string
- port: string
- createStatus: boolean
- token: string
Returns void
Implementation of WebSocketAdapter.connect
- Defined in nakama-js/web_socket_adapter.ts:137

isOpen

isOpen(): boolean
Returns boolean
Implementation of WebSocketAdapter.isOpen
- Defined in nakama-js/web_socket_adapter.ts:133

send

send(msg: any): void
Parameters
- msg: any
Returns void
Implementation of WebSocketAdapter.send
- Defined in nakama-js/web_socket_adapter.ts:147

Generated using TypeDoc