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/ws</nowiki></code> namespace, which is statically bound to the {{Code|ws}} prefix. The module must * As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, some query optimizations will be imported in the query prolog:suppressed.

<pre class="brushGeneral Functions= ==ws:xquery">id== {| width='100%'|-| width='120' | '''Signatures'''import module namespace |{{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.|} == "httpws://basexids== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|ws:ids||xs:string*}}|-| '''Summary'''|Returns the ids of all currently registered WebSockets.org/modules/|} ==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.</pre>|}

=FunctionsSending Data=

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

|Sends a <code>$message</code>, which may be of type xs:string, xs:base64Binary or xs:hexBinary, to the users 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 {{Code|xs:base64Binary}} and {{Code|xs:hexBinary}} will be transmitted as binary messages.* Function items (maps, arrays) will be serialized as JSON and transmitted as string messages.* All other items will be serialized with the 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:ideval==

|{{Func|ws:ideval|$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 />

|Returns Schedules the ID evaluation of the current 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:<syntaxhighlight lang="xquery">declare %ws:message('/tasks', '{$message}')function local:message($message) { ws:eval('prof:sleep(10000), "Your message has been processed."')}; </syntaxhighlight>

=WebSocket Attributes= ==ws:idsget==

|{{Func|ws:idsget|$id as 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 ids value of all currently registered an attribute with the specified {{Code|$name}} from the WebSocket clientswith 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 with the specified id exists.

==ws:pathset==

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

|Returns the path specified {{Code|value}} of the attribute with the specified {{Code|$name}} from the WebSocket client with the specified {{CodeMono|$id}}.|-| '''Errors'''|{{Error|not-found|#Errors}} No WebSocket with the specified id exists.<br>{{Error|set|#Errors}} The supplied value cannot be materialized.

==ws:closedelete==

|{{Func|ws:closedelete|$id as xs:string, $name as xs:string|empty-sequence()}}

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

<pre classsyntaxhighlight lang="brush:xquery">import module namespace ws = "http://basex.org/modules/Websocketws";

function local:connect() as xs:string empty-sequence() {

</presyntaxhighlight>

<pre classsyntaxhighlight lang="brush:xquery">import module namespace ws = "http://basex.org/modules/Websocketws";

) as xs:string empty-sequence() {

</presyntaxhighlight>