index :: net

net.ws.client

WebSocket client

available since version: 0.9.8

---

methods:

• close gracefully close connection (with websocket handshake)
  

• connect connect to websocket server
  parameters:
  • URL url - ws://HOST:PORT/, for ex.: ws://127.0.0.1:9000/path
    type: symbol
    required: True
    

• flush flush output stream: sends all buffered messages.
  

• latency measure rountrip latency. Outputs: latency TIME_MSEC
  

• ping send ping message to server (on server answer outputs: pong DATA)
  parameters:
  • [DATA] list of integers in [0..255] range
    type: list
    
• send send as text message
  parameters:
  • [ARGS] arguments
    type: list
    
• send_array send as Pd array content as json array
  parameters:

  • ARR array name
    type: symbol
    required: True
    

  • [START=0] array start index
    type: int
    units: samp
    

  • [LENGTH] read length. If not specified - read until array end.
    type: int
    units: samp
    

• send_binary send as binary bytes
  parameters:
  • [ARGS] list of integers in [0..255] range
    type: list
    
• send_json send as encoded json
  parameters:
  • [ARGS] arguments
    type: list
    
• write write as text message to output buffer. You have to call [flush( method for sending.
  parameters:
  • [ARGS] arguments
    type: list
    
• write_binary write as binary bytes to output buffer. You have to call [flush( method for sending.
  parameters:
  • [ARGS] list of integers in [0..255] range
    type: list
    
• write_json write as encoded json to output buffer. You have to call [flush( method for sending.
  parameters:
  • [ARGS] arguments
    type: list
    

properties:

• @mode Get/set parsing mode for incoming messages. If 'fudi' - interpret incoming websocket data as Pd messages, if 'sym' - always interpret as symbols, 'data' - parse ceammc data, 'json' - convert json values to ceammc data.
  type: symbol
  enum: data, fudi, json, sym
  default: fudi
  

inlets:

• message input
  type: control

outlets:

• output messages: latency, ping, text, binary, closed, connected, disconnected
  type: control

keywords:

websocket net client

See also: [net.ws.server]

Authors: Serge Poltavsky

License: GPL3 or later