Changes

* The module will be available if the {{Code|basex-api}} package must be included library is found in the classpath. This is always the case if you use one of the complete distributions of BaseX (zip, exe, war) of BaseX.* All functions and errors are assigned to the <code><nowiki>http://basex.org/modules/websocketws</nowiki></code> namespace, which is statically bound to the {{Code|ws}} prefix. The Prior to {{Version|9.2}}, the module must needed to be imported in the query prolog: 

import module namespace ws = "http://basex.org/modules/Websocketws";

* As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, some query optimizations will be suppressed. =General Functions= ==ws:id== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:id||xs:string}}|-| '''Summary'''|Returns the ID of the current WebSocket.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.|} ==ws:ids== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:ids||xs:string*}}|-| '''Summary'''|Returns the ids of all currently registered WebSocket.|} ==ws:path== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:path|$id as xs:string|xs:string}}|-| '''Summary'''|Returns the path of the WebSocket with the specified {{Code|$id}}.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.|} ==ws:close== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:close|$id as xs:string|empty-sequence()}}|-| '''Summary'''|Closes the connection of the WebSocket with the specified {{Code|$id}}.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.|} =Sending Data=

|{{Func|ws:send|$message as xs:anyAtomicTypeitem(), $ids as xs:string* |empty-sequence()}}

|Sends a <code>$message</code> which may to the clients with the specified <code>$ids</code>. Ids that cannot be assigned to clients will be ignored. The message will be handled as follows:* Items of type xs:string, {{Code|xs:base64Binary, or }} and {{Code|xs:hexBinary to the user}} will be transmitted as binary messages.* Function items (smaps, arrays) will be serialized as JSON and transmitted as string messages.* All other items will be serialized with the ID(s) <code>$ids</code>default serialization options and transmitted as string messages.

|Broadcasts a <code>$message</code> which may be of type xs:string, xs:base64Binary, or xs:hexBinary to all connected clients except to the caller. Invocations of this convenience function are equivalent to <code>ws:send($message, ws:ids()[. != ws:id()])</code>. See [[#ws:send|ws:send]] for more details on the message handling.

|Emits a <code>$message</code> which may be to all connected clients. Invocations of type xsthis function are equivalent to <code>ws:stringsend($message, xsws:ids())</code>. See [[#ws:base64Binary, or xssend|ws:hexBinary to all connected clientssend]] for more details on the message handling.

==ws:eval== {{Mark|Introduced with 9.2:}} {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:eval|$query as xs:anyAtomicItem|xs:string}}<br />{{Func|ws:eval|$query as xs:anyAtomicItem, $bindings as map(*)?|xs:string}}<br />{{Func|ws:eval|$query as xs:anyAtomicItem, $bindings as map(*)?, $options as map(*)?|xs:string}}<br />|-| '''Summary'''|Schedules the evaluation of the supplied {{Code|$query}} and returns the result to the calling WebSocket client. The query can be a URI or a string, and variables and context items can be declared via {{Code|$bindings}} (see {{Function|XQuery|xquery:eval}} for more details). The following {{Code|$options}} can be supplied:* {{Code|base-uri}}: sets the [https://www.w3.org/TR/xquery-31/#dt-static-base-uri base-uri property] for the query. This URI will be used when resolving relative URIs, such as with {{Code|fn:doc}}.* {{Code|id}}: sets a custom job id. The id must not start with the standard <code>job</code> prefix, and it can only be assigned if no job with the same name exists.Query scheduling is recommendable if the immediate query execution might be too time consuming and lead to a timeout.|-| '''Errors'''|{{Error|overflow|#Errors}} Query execution is rejected, because too many jobs are queued or being executed. <br/>{{Error|id|#Errors}} The specified id is invalid or has already been assigned.|-| '''Examples'''|* Schedule a second query that will notify the client 10 seconds later that a message was processed:<pre class='brush:xquery'>declare %ws:message('/tasks', '{$message}')function local:message($message) { ws:eval('prof:sleep(10000), "Your message has been processed."')}; </pre>|} =WebSocket Attributes= ==ws:get==

|{{Func|ws:get|$idas xs:string, $name as xs:string|item()*}}<br/>{{Func|ws:get|$id as xs:string, $name as xs:string, $default as item()*|item()*}}

|Returns the ID value of an attribute with the current specified {{Code|$name}} from the WebSocket with the specified {{Code|$id}}. If the attribute is unknown, an empty sequence or the optionally specified {{Code|$default}} value will be returned instead.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket clientwith the specified id exists.

==ws:idsset==

|{{Func|ws:ids|set|$id as xs:string, $name as xs:string, $value as item()*|empty-sequence()}}

|Returns the ids specified {{Code|value}} of all currently registered the attribute with the specified {{Code|$name}} from the WebSocket clientwith the specified {{Mono|$id}}.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.<br>{{Error|set|#Errors}} The supplied value cannot be materialized.

==ws:pathdelete==

|{{Func|ws:path|delete|$id as xs:string}}<br>{{Func|ws:path|, $id name as xs:string|xs:stringempty-sequence()}}

|Returns Deletes an attribute with the path of specified {{Code|$name}} from the current WebSocket client, or the client with the specified {{CodeMono|$id}}.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.

(: Import the WebSocket module :)import module namespace ws = "http://basex.org/modules/Websocketws";

%ws:connect("'/"')function local:connect() as empty-sequence() { let $client-id := ws:id() let $client-path := ws:path() let $response message := json:serialize(map { <json 'type="object">': 'Connect', <messageType>UserConnected</messageType> <clientId>{ 'id': $client-id}</clientId> <clientPath>{$client-path }</clientPath> </json> ) return ws:broadcast($responsemessage)

* First of all: include the websocket module* The function has a <code>$%ws:connect("/")</code> annotation . It gets called if a client successfully creates a websocket WebSocket connection to the path "<code>/</" code> (checkout check out [[WebSockets]] for further information).* Get A JSON response is generated, which contains the <code>new client-id</code> and the a <code>client-path</code> with <code>ws:id()</code> and <code>ws:path()Connect</code>string.* Create a json-result * Broadcast the result This response will be sent to all other connected clients without the calling client.

(: Import the Websockets module :)import module namespace ws = "http://basex.org/modules/Websocketws";

%ws:message("'/"', "'{$message}"')

$message as xs:string

let $client-ids := ws:ids() let $fist-client-id := fn:head($client-ids) let $send-to-id := ws:send($message, $first-client-id) let $path-first-client := ws:path($first-client-id) let $response := json:serialize( <json type="object"> <messageType>PathFirstClient</messageType> <path>map { 'message': $path-first-client message }</path> </json> ) return ws:emit($responsemessage)

* First of all, import the websocket module* The annotation function has a <code>$%ws:message("/",{$message}")</code> annotation. It gets called if a client sends a new message arrives at .* A JSON response is generated, which contains the server (checkout [[WebSockets]] for further information)message string.* With <code>ws:ids()</code> you This response will get the ids of be sent to all connected clients(including the calling client).* =Errors= {| class="wikitable" width="100%"! width="110"|Code|Description|-|{{Code|set}}|The function <code>ws:send($message,$firstsupplied value cannot be materialized.|-client|{{Code|not-id)</code> sends the <code>$message</code> to the client found}}|No WebSocket with the specified id <code>$first-client-id</code>exists.|} =Changelog= ;Version 9.2 * <code>Added: [[#ws:path($first-client-id)</code> returns the path of the client with the id <code>$first-client-id</code>* To emit a message to all connected clients you call <code>eval|ws:emit($response)</code>eval]] This module was introduced with Version 9.1.