WSServer Class

Properties   Methods   Events   Configuration Settings   Errors  

The WSServer component is used to create a WebSocket server.

Class Name

IPWorksWS_WSServer

Procedural Interface

 ipworksws_wsserver_open();
 ipworksws_wsserver_close($res);
 ipworksws_wsserver_register_callback($res, $id, $function);
 ipworksws_wsserver_get_last_error($res);
 ipworksws_wsserver_get_last_error_code($res);
 ipworksws_wsserver_set($res, $id, $index, $value);
 ipworksws_wsserver_get($res, $id, $index);
 ipworksws_wsserver_do_config($res, $configurationstring);
 ipworksws_wsserver_do_disconnect($res, $connectionid);
 ipworksws_wsserver_do_doevents($res);
 ipworksws_wsserver_do_interrupt($res, $connectionid);
 ipworksws_wsserver_do_send($res, $connectionid, $data);
 ipworksws_wsserver_do_sendfile($res, $connectionid, $filename);
 ipworksws_wsserver_do_sendtext($res, $connectionid, $text);
 ipworksws_wsserver_do_shutdown($res);

Remarks

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

The WSServer 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 LocalPort. This is the port on which incoming connections will be accepted. To begin listening set Listening to True.

When a client connects the WebSocketOpenRequest 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 DataIn event. To send data to a client you may use the Send, SendText, or SendFile methods. You may also set WSConnectionDataToSend.