WSProxy Class

Properties   Methods   Events   Configuration Settings   Errors  

The WSProxy component is used to forward traffic received on a WebSocket to another destination.

Class Name

IPWorksWS_WSProxy

Procedural Interface

 ipworksws_wsproxy_open();
 ipworksws_wsproxy_close($res);
 ipworksws_wsproxy_register_callback($res, $id, $function);
 ipworksws_wsproxy_get_last_error($res);
 ipworksws_wsproxy_get_last_error_code($res);
 ipworksws_wsproxy_set($res, $id, $index, $value);
 ipworksws_wsproxy_get($res, $id, $index);
 ipworksws_wsproxy_do_config($res, $configurationstring);
 ipworksws_wsproxy_do_disconnect($res, $connectionid);
 ipworksws_wsproxy_do_doevents($res);
 ipworksws_wsproxy_do_shutdown($res);

Remarks

The WSProxy class provides a simple way to accept a WebSocket connection and forward the incoming data to a separate destination host.

The WSProxy class is a server that accepts incoming WebSocket connections and will establish an outgoing connection to the specified forward host and forward data it receives onto the final destination. For instance, take this diagram:

Client ---WebSocket protocol---> WSProxy ---plain TCP---> Forward Host

In this example the Client establishes a WebSocket connection to the WSProxy component. The WSProxy class then establishes a separate standard TCP connection to Forward Host. The Client can then communicate with the Forward Host and data will be passed through WSProxy.

To begin using the class first specify a valid value for LocalPort. This is the port on which incoming connections will be accepted. Specify values for DefaultForwardHost and DefaultForwardPort. This is the destination to which the data will be forwarded. Note that you may override these values on a per connection basis if desired when the client connects.

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). You may also set the ForwardHost and ForwardPort event parameters to override the default values.

Once the connection is established all data received on the connection will automatically be forwarded to the forward host. Any data received from the forward host will be sent back to the client. The client is now able to freely communicate with the forward host.