WebSocketServer Class

Properties   Methods   Events   Configuration Settings   Errors  

The WebSocketServer class is used to create a WebSocket server.

Syntax

class ipworksws.WebSocketServer

Remarks

The WebSocketServer class provides an easy way to accept connections from WebSocket clients and transfer data.

The WebSocketServer class is a server that accepts incoming WebSocket connections and provides an easy way to send and receive data over the connection.

To begin using the class first specify a valid value for local_port. This is the port on which incoming connections will be accepted. To begin listening set listening to True.

When a client connects the on_web_socket_open_request event will fire. To accept the connection simply allow the event to complete. To reject the request set the StatusCode parameter to an HTTP error code (such as 401).

Once the connection is received incoming data will be provide through the on_data_in event. To send data to a client you may use the send, send_text, or send_file methods. You may also set web_socket_connection_data_to_send.

Note: Server components are designed to process events as they occur. To ensure events are processed in a timely manner do_events should be called in a loop after the server is started.