# doc-cache created by Octave 10.1.0
# name: cache
# type: cell
# rows: 3
# columns: 3
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
ws_connect


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 735
 -- Function File: WS = ws_connect (HOST, URI)
 -- Function File: WS = ws_connect (HOST, URI, PORT)

     Connect to the WebSocket server at the given “uri“.

     Given the:
        • HOST the IP address of the host, in string format.
        • URI the uri (string) to consult in the websocket host, it must
          start with "/".
        • PORT the target port (integer) of the host
     WS a WebSocket sctructure with the following items.
        • CLIENT a specific TCP socket for this connection.
        • HOST the IP address of the host, in string format.
        • URI the uri (string) to consult in the websocket host, it must
          start with "/".
        • PORT the target port (integer) of the host


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 55
Connect to the WebSocket server at the given “uri“.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
ws_receive


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 302
 -- Function File: RESP = ws_receive (WS)

     Receive from the WebSocket "ws".

     Given the:
        • WS A websocket structure, containing a client and the
          characteristics of said websocket
     RESP a string (if received text) or a set of binary values (if
     received bin values).


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 32
Receive from the WebSocket "ws".



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
ws_send


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 901
 -- Function File: LEN = ws_send (WS, DATA)
 -- Function File: LEN = ws_send (WS, DATA, MODE)
 -- Function File: LEN = ws_send (WS, DATA, MODE, MASK)

     Send data to the WebSocket "ws".

     Given the:
        • WS A websocket structure, containing a client and the
          characteristics of said websocket
        • DATA The data that will be sent to the WebSocket.
        • MODE The data mode, an string that can be either "text",
          "binary", "ping" or "pong".  If this is not present, the text
          mode is used by default.  In case of the last two, data is
          ignored.
        • MASK Either 1 or 0 indicating if the message will be masked or
          not respectively.  The masking isn’t implemented yet and is
          disabled by default.  Enabling it will apply a zero mask to
          the data, keeping it the same.
     LEN the quantity of bytes sent.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 32
Send data to the WebSocket "ws".





