WebSocket Module - Revision history

CG: Text replacement - "" to ""

2023-12-01T16:35:50Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:32:17Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 12:54, 31 October 2023

2023-10-31T12:54:05Z

CG: /* WebSocket Attributes */

2023-06-28T09:39:36Z

WebSocket Attributes

CG: /* ws:set */

2023-06-28T09:37:04Z

ws:set

CG at 15:08, 9 March 2023

2023-03-09T15:08:04Z

CG at 14:25, 9 March 2023

2023-03-09T14:25:03Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:02:47Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:02, 9 March 2023

2023-03-09T11:02:14Z

CG: Text replacement - "
" to "
"

2023-03-09T08:20:04Z

Text replacement - "<br />" to "<br/>"

@@ Line 140: / Line 140: @@
    ws:eval('prof:sleep(10000), "Your message has been processed."')
 };
-</syntaxhighlight>
+</pre>
 |}
@@ Line 215: / Line 215: @@
    return ws:broadcast($message)
 };
-</syntaxhighlight>
+</pre>
 '''Explanation:'''
@@ Line 236: / Line 236: @@
    return ws:emit($message)
 };
-</syntaxhighlight>
+</pre>
 '''Explanation:'''

@@ Line 134: / Line 134: @@
+|
 * Schedule a second query that will notify the client 10 seconds later that a message was processed:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare
    %ws:message('/tasks', '{$message}')
@@ Line 202: / Line 202: @@
 ==Example 1==
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace ws = "http://basex.org/modules/ws";
@@ Line 225: / Line 225: @@
 ==Example 2==
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace ws = "http://basex.org/modules/ws";

@@ Line 5: / Line 5: @@
 * The module will be available if the {{Code|basex-api}} library is found in the classpath. This is the case if you use one of the complete distributions of BaseX (zip, exe, war).
 * 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.
-* As sessions are side-effecting operations, all functions are flagged as ''non-deterministic''. As a result, some query optimizations will be suppressed.
+* As sessions are side-effecting operations, all functions are flagged as ''nondeterministic''. As a result, some query optimizations will be suppressed.
 =General Functions=

@@ Line 157: / Line 157: @@
 |- valign="top"
 | '''Summary'''
-|Returns the value of an attribute with the 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.
+|Returns the value of an attribute with the specified {{Code|$name}} for 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.
 |- valign="top"
 | '''Errors'''
@@ Line 175: / Line 175: @@
 |- valign="top"
 | '''Summary'''
-|Assigns the specified {{Code|$value}} to the attribute with the specified {{Code|$name}} from the WebSocket with the specified {{Mono|$id}}.
+|Assigns the specified {{Code|$value}} to the attribute with the specified {{Code|$name}} for the WebSocket with the specified {{Mono|$id}}.
 |- valign="top"
 | '''Errors'''

@@ Line 175: / Line 175: @@
 |- valign="top"
 | '''Summary'''
-|Returns the specified {{Code|value}} of the attribute with the specified {{Code|$name}} from the WebSocket with the specified {{Mono|$id}}.
+|Assigns the specified {{Code|$value}} to the attribute with the specified {{Code|$name}} from the WebSocket with the specified {{Mono|$id}}.
 |- valign="top"
 | '''Errors'''

@@ Line 119: / Line 119: @@
    $query     as xs:anyAtomicType,
    $bindings  as map(*)?           := (),
-   $options   as map(*)?           := ()
+   $options   as map(*)?           := map { }
 ) as xs:string</pre>
 |- valign="top"

@@ Line 74: / Line 74: @@
 | width='120' | '''Signature'''
 |<pre>ws:send(
-   $message  as item()
+   $message  as item(),
    $ids      as xs:string*
 ) as empty-sequence()</pre>
@@ Line 117: / Line 117: @@
 | width='120' | '''Signature'''
 |<pre>ws:eval(
-   $query     as xs:anyAtomicType
+   $query     as xs:anyAtomicType,
-   $bindings  as map(*)?           := ()
+   $bindings  as map(*)?           := (),
    $options   as map(*)?           := ()
 ) as xs:string</pre>
@@ Line 151: / Line 151: @@
 | width='120' | '''Signature'''
 |<pre>ws:get(
-   $id       as xs:string
+   $id       as xs:string,
-   $name     as xs:string
+   $name     as xs:string,
    $default  as item()*    := ()
 ) as item()*</pre>
@@ Line 169: / Line 169: @@
 | width='120' | '''Signature'''
 |<pre>ws:set(
-   $id     as xs:string
+   $id     as xs:string,
-   $name   as xs:string
+   $name   as xs:string,
    $value  as item()*
 ) as empty-sequence()</pre>
@@ Line 187: / Line 187: @@
 | width='120' | '''Signature'''
 |<pre>ws:delete(
-   $id    as xs:string
+   $id    as xs:string,
    $name  as xs:string
 ) as empty-sequence()</pre>

@@ Line 13: / Line 13: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:id() as xs:string</pre>
 |- valign="top"
@@ Line 27: / Line 27: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:ids() as xs:string*</pre>
 |- valign="top"
@@ Line 38: / Line 38: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:path(
    $id  as xs:string
@@ Line 54: / Line 54: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:close(
    $id  as xs:string
@@ Line 72: / Line 72: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:send(
    $message  as item()
@@ Line 89: / Line 89: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:broadcast(
    $message  as xs:anyAtomicType
@@ Line 102: / Line 102: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:emit(
    $message  as xs:anyAtomicType
@@ Line 115: / Line 115: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:eval(
    $query     as xs:anyAtomicType
@@ Line 149: / Line 149: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:get(
    $id       as xs:string
@@ Line 167: / Line 167: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:set(
    $id     as xs:string
@@ Line 185: / Line 185: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>ws:delete(
    $id    as xs:string