This XQuery Module contains functions for accessing specific WebSocket functions and setting attributes on a WebSocket connection. This module is mainly useful in the context of WebSockets.
Conventions
- The
basex-api
package must be included in the classpath. This is always the case if you use one of the complete distributions (zip, exe, war) of BaseX.
- All functions and errors are assigned to the
http://basex.org/modules/websocket
namespace. The module must be imported in the query prolog:
import module namespace websocket = "http://basex.org/modules/websocket";
...
Functions
websocket:broadcast
Signatures
|
websocket:broadcast($message as xs:anyAtomicType) as empty-sequence()
|
Summary
|
Broadcasts message which may be of type xs:string, xs:base64Binary, or xs:hexBinary to all connected members except to the caller.
|
websocket:id
Signatures
|
websocket:id() as xs:string
|
Summary
|
Returns the ID of the current WebSocket connection.
|
websocket:get
Signatures
|
websocket:get($key as xs:string) as xs:string
|
Summary
|
Returns the WebSocket attribute with the key $key . If the $id parameter is set, it returns the attribute of a specific User with the ID $id
|
websocket:set
Signatures
|
websocket:set($key as xs:string, $value as xs:string) as empty-sequence()
|
Summary
|
Sets a WebSocket attribute with the key $key and the value $value . If the $id parameter is set, the attribute of a specific user with the ID $id is set.
|
websocket:delete
Signatures
|
websocket:delete($key as xs:string) as empty-sequence()
|
Summary
|
Removes a session attribute from the current WebSocketClient. If the $id parameter is set, the attribute of a specific user with the ID $id will be deleted.
|
websocket:path
Signatures
|
websocket:path() as xs:string
|
Summary
|
Returns the path of the current WebSocketClient. If the $id parameter is set, the path of a specific user with the ID $id will be returned.
|