WebSocket

Management of connections and communication with customers.

---

allSessionsEndpoints

---

_ws.allSessionsEndpoints() : Values

Return

( Values )

---

awaitStream

---

_ws.awaitStream() : boolean

Return

( boolean )

---

binaryStreamed

---

_ws.binaryStreamed() : byte[]

Return

( byte[] )

---

broadcast

---

_ws.broadcast(endpointName: string, data: Values) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
data	Values

Return

( void )

---

broadcastAsService

---

_ws.broadcastAsService(endpointName: string, path: string, message: Values) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
path	string
message	Values

Return

( void )

---

_ws.broadcastAsService(endpointName: string, message: Values) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
message	Values

Return

( void )

---

broadcastBinary

---

_ws.broadcastBinary(endpointName: string, content: byte[]) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
content	byte[]

Return

( void )

---

_ws.broadcastBinary(endpointName: string, path: string, content: byte[]) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
path	string
content	byte[]

Return

( void )

---

broadcastService

---

_ws.broadcastService(endpointName: string, path: string, message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
path	string
message	Values

Return

( boolean )

---

_ws.broadcastService(endpointName: string, message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
message	Values

Return

( boolean )

---

broadcastText

---

_ws.broadcastText(endpointName: string, message: string) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
message	string

Return

( void )

---

_ws.broadcastText(endpointName: string, path: string, message: string) : void

Attributes

NAME	TYPE	DESCRIPTION
endpointName	string
path	string
message	string

Return

( void )

---

close

---

_ws.close() : boolean

Return

( boolean )

---

_ws.close(sessionId: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string

Return

( boolean )

---

closeCode

---

_ws.closeCode() : string

Return

( string )

---

closeData

---

_ws.closeData() : Values

Return

( Values )

---

closeReason

---

_ws.closeReason() : string

Return

( string )

---

closeSession

---

_ws.closeSession(id: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( boolean )

---

_ws.closeSession(id: string, reason: string, message: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
id	string
reason	string
message	string

Return

( boolean )

---

config

---

_ws.config() : Values

Return

( Values )

---

data

---

_ws.data() : Values

Return

( Values )

---

_ws.data(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

fullPath

---

_ws.fullPath() : string

Return

( string )

---

_ws.fullPath(id: string) : string

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( string )

---

getAllSessionsEndpoints

---

_ws.getAllSessionsEndpoints() : Values

Return

( Values )

---

getCloseCode

---

_ws.getCloseCode() : string

Return

( string )

---

getCloseData

---

_ws.getCloseData() : Values

Return

( Values )

---

getCloseReason

---

_ws.getCloseReason() : string

Return

( string )

---

getConfig

---

_ws.getConfig() : Values

Return

( Values )

---

getData

---

_ws.getData() : Values

Return

( Values )

---

_ws.getData(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

getFullPath

---

_ws.getFullPath() : string

Return

( string )

---

_ws.getFullPath(id: string) : string

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( string )

---

getMessage

---

_ws.getMessage() : WSMessage

Return

( WSMessage )

---

getPath

---

_ws.getPath() : Values

Return

( Values )

---

_ws.getPath(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

getQS

---

_ws.getQS() : Values

Return

( Values )

---

getSession

---

_ws.getSession() : jakarta.websocket.Session

Return

( jakarta.websocket.Session )

---

_ws.getSession(id: string) : jakarta.websocket.Session

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( jakarta.websocket.Session )

---

getSessionEndpoint

---

_ws.getSessionEndpoint() : Values

Return

( Values )

---

_ws.getSessionEndpoint(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

getSessionId

---

_ws.getSessionId() : string

Return

( string )

---

isBinaryStreamed

---

_ws.isBinaryStreamed() : boolean

Return

( boolean )

---

isClose

---

_ws.isClose() : boolean

Return

( boolean )

---

isConnect

---

_ws.isConnect() : boolean

Return

( boolean )

---

isStream

---

_ws.isStream() : boolean

Return

( boolean )

---

isTextStreamed

---

_ws.isTextStreamed() : boolean

Return

( boolean )

---

message

---

_ws.message() : WSMessage

Return

( WSMessage )

---

path

---

_ws.path() : Values

Return

( Values )

---

_ws.path(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

qs

---

_ws.qs() : Values

Return

( Values )

---

send

---

_ws.send(content: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
content	string

Return

( boolean )

---

_ws.send(sessionId: string, content: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
content	string

Return

( boolean )

---

_ws.send(sessionId: string, content: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
content	Values

Return

( boolean )

---

_ws.send(content: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
content	Values

Return

( boolean )

---

sendAsService

---

_ws.sendAsService(sessionId: string, message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
message	Values

Return

( boolean )

---

_ws.sendAsService(message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
message	Values

Return

( boolean )

---

sendBinary

---

_ws.sendBinary(content: byte[]) : boolean

Attributes

NAME	TYPE	DESCRIPTION
content	byte[]

Return

( boolean )

---

_ws.sendBinary(sessionId: string, content: byte[]) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
content	byte[]

Return

( boolean )

---

sendService

---

_ws.sendService(sessionId: string, message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
message	Values

Return

( boolean )

---

_ws.sendService(message: Values) : boolean

Attributes

NAME	TYPE	DESCRIPTION
message	Values

Return

( boolean )

---

sendText

---

_ws.sendText(content: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
content	string

Return

( boolean )

---

_ws.sendText(sessionId: string, content: string) : boolean

Attributes

NAME	TYPE	DESCRIPTION
sessionId	string
content	string

Return

( boolean )

---

session

---

_ws.session() : jakarta.websocket.Session

Return

( jakarta.websocket.Session )

---

_ws.session(id: string) : jakarta.websocket.Session

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( jakarta.websocket.Session )

---

sessionEndpoint

---

_ws.sessionEndpoint() : Values

Return

( Values )

---

_ws.sessionEndpoint(id: string) : Values

Attributes

NAME	TYPE	DESCRIPTION
id	string

Return

( Values )

---

sessionId

---

_ws.sessionId() : string

Return

( string )

---

textStreamed

---

_ws.textStreamed() : string

Return

( string )

---

_ws.textStreamed(charset: string) : string

Attributes

NAME	TYPE	DESCRIPTION
charset	string

Return

( string )

---