index :: net

net.ws.server

WebSocket server

available since version: 0.9.8

---

methods:

• clients output connected clients as list CLIENT_ID CLIENT_ADDR… etc.
  

• close gracefully close connection with specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

• listen starts/stop websocket server
  parameters:

  • PORT listening port. If 0 - stops server.
    type: int
    required: True
    

  • [ADDR] listening address. If not specified - using 0.0.0.0 (all network interfaces)
    type: symbol
    

• ping send ping message to specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

  • [DATA] list of integers in [0..255] range
    type: list
    

• send send as text message to specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

  • [ARGS] arguments
    type: list
    

• send_binary send as binary bytes to specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

  • [DATA] list of integers in [0..255] range
    type: list
    

• send_json send as encoded json to specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

  • [ARGS] arguments
    type: list
    

• shutdown abort connection with specified client(s)
  parameters:

  • TARGET client selector. If '*' or 'all' - send message to all clients. If 'first' - send message to first connected client. If 'last' - send message to last connected client. If 'id' or '==' - send message to client with specified ID. If 'except' or '!=' - send message to all client except specified.
    type: symbol
    required: True
    

  • [ID] client ID. Required, if client selector is one of: 'id', '==', '!=' or 'except'.
    type: int
    

• stop stops server, equal to [listen 0( message
  

properties:

• @mode Get/set parsing mode for incoming client 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:

• [connected( when client is connected, [closed( when client closed, [text( on text message, [ping( on ping message from client, [binary( on binary message
  type: control
• list: CLIENT_ID CLIENT_ADDR
  type: control

keywords:

websocket net server

See also: [net.ws.client]

Authors: Serge Poltavsky

License: GPL3 or later