WSServer Class

Properties   Methods   Events   Config Settings   Errors  

The WSServer class is used to create a WebSocket server.

Class Name

IPWorksSSL_WSServer

Procedural Interface

 ipworksssl_wsserver_open();
 ipworksssl_wsserver_close($res);
 ipworksssl_wsserver_register_callback($res, $id, $function);
 ipworksssl_wsserver_get_last_error($res);
 ipworksssl_wsserver_get_last_error_code($res);
 ipworksssl_wsserver_set($res, $id, $index, $value);
 ipworksssl_wsserver_get($res, $id, $index);
 ipworksssl_wsserver_do_changelinemode($res, $connectionid, $linemode);
 ipworksssl_wsserver_do_config($res, $configurationstring);
 ipworksssl_wsserver_do_disconnect($res, $connectionid);
 ipworksssl_wsserver_do_doevents($res);
 ipworksssl_wsserver_do_interrupt($res, $connectionid);
 ipworksssl_wsserver_do_ping($res, $connectionid);
 ipworksssl_wsserver_do_send($res, $connectionid, $data);
 ipworksssl_wsserver_do_sendbytes($res, $connectionid, $data);
 ipworksssl_wsserver_do_sendfile($res, $connectionid, $filename);
 ipworksssl_wsserver_do_sendtext($res, $connectionid, $text);
 ipworksssl_wsserver_do_shutdown($res);
 ipworksssl_wsserver_do_startlistening($res);
 ipworksssl_wsserver_do_stoplistening($res);

Remarks

The WSServer class functions as a server that facilitates incoming WebSocket connections and offers a convenient means of transmitting and receiving data over the established connections.

To start, the LocalPort property must be specified to a valid port. This port will be used to accept incoming connections. Then, call the StartListening method to start listening on the specified port. The WSServer class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method. The SSLCert properties are used to select a certificate for the server. Note: A valid certificate MUST be selected before the server can function.

Upon a client's connection, the WebSocketOpenRequest event will be fired. To accept the connection, simply allow the event to complete its execution. Conversely, to reject the request, the StatusCode parameter can be set to an appropriate HTTP error code, such as 401.

By default, each instance of WSServer has the capacity to handle up to 1,000 simultaneous incoming connections. You can change the maximum number of simultaneous connections by adjusting the MaxConnections configuration setting. This setting allows you to increase the limit up to 100,000 or decrease it to a lower value based on your needs.

Each connection is identified by a unique ConnectionId, an identifier generated by the component to distinguish individual connections. The ConnectionId is also included as a parameter in WSServer's events to identify the associated connection.

After receiving a connection, incoming data can be accessed through the DataIn event. To transmit data to a client, the Send, SendText, or SendFile methods can be employed, or the WSConnectionDataToSend field can be set accordingly.

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

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ConnectionBacklog Property (IPWorksSSL_WSServer Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Object Oriented Interface

public function getConnectionBacklog();


public function setConnectionBacklog($value);

Procedural Interface

ipworksssl_wsserver_get($res, 1 );


ipworksssl_wsserver_set($res, 1, $value );

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

WSConnectionCount Property (IPWorksSSL_WSServer Class)

The number of records in the WSConnection arrays.

Object Oriented Interface

public function getWSConnectionCount();

Procedural Interface

ipworksssl_wsserver_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• WSConnectionAcceptData
• WSConnectionBytesSent
• WSConnectionConnected
• WSConnectionConnectionId
• WSConnectionDataFormat
• WSConnectionDataToSend
• WSConnectionHost
• WSConnectionLineMode
• WSConnectionLocalAddress
• WSConnectionOrigin
• WSConnectionReadyToSend
• WSConnectionRemoteHost
• WSConnectionRemotePort
• WSConnectionRequestHeaders
• WSConnectionRequestURI
• WSConnectionSubProtocols
• WSConnectionTimeout

The array indices start at 0 and end at WSConnectionCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

WSConnectionAcceptData Property (IPWorksSSL_WSServer Class)

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection.

Object Oriented Interface

public function getWSConnectionAcceptData($connectionid);


public function setWSConnectionAcceptData($connectionid, $value);

Procedural Interface

ipworksssl_wsserver_get($res, 3 , $connectionid);


ipworksssl_wsserver_set($res, 3, $value , $connectionid);

Default Value

true

Remarks

Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. Setting this to true re-enables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is not available at design time.

Data Type

Boolean

WSConnectionBytesSent Property (IPWorksSSL_WSServer Class)

This property shows how many bytes were sent after the last assignment to DataToSend .

Object Oriented Interface

public function getWSConnectionBytesSent($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 4 , $connectionid);

Default Value

0

Remarks

This property shows how many bytes were sent after the last assignment to WSConnectionDataToSend. Please check WSConnectionDataToSend for more information.

Note: This property will always return 0 when the class is operating in the synchronous mode (i.e., the WSConnectionTimeout property is set to a positive value).

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

WSConnectionConnected Property (IPWorksSSL_WSServer Class)

This property is used to disconnect individual connections and/or show their status.

Object Oriented Interface

public function getWSConnectionConnected($connectionid);


public function setWSConnectionConnected($connectionid, $value);

Procedural Interface

ipworksssl_wsserver_get($res, 5 , $connectionid);


ipworksssl_wsserver_set($res, 5, $value , $connectionid);

Default Value

false

Remarks

This property is used to disconnect individual connections and/or show their status.

The WSConnectionConnected property may be set to false to close the connection.

WSConnectionConnected also shows the status of a particular connection (connected/disconnected).

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is not available at design time.

Data Type

Boolean

WSConnectionConnectionId Property (IPWorksSSL_WSServer Class)

This property contains an identifier generated by the class to identify each connection.

Object Oriented Interface

public function getWSConnectionConnectionId($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 6 , $connectionid);

Default Value

''

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionDataFormat Property (IPWorksSSL_WSServer Class)

The format of the data being sent.

Object Oriented Interface

public function getWSConnectionDataFormat($connectionid);


public function setWSConnectionDataFormat($connectionid, $value);

Procedural Interface

ipworksssl_wsserver_get($res, 7 , $connectionid);


ipworksssl_wsserver_set($res, 7, $value , $connectionid);

Default Value

0

Remarks

The format of the data being sent. When data is sent over an established connection it is either considered as text or binary data. Text data is UTF-8 encoded. Binary data has no encoding associated with it.

Possible values are:

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is not available at design time.

Data Type

Integer

WSConnectionDataToSend Property (IPWorksSSL_WSServer Class)

This property contains a string of data to be sent to the remote host.

Object Oriented Interface

public function setWSConnectionDataToSend($connectionid, $value);

Procedural Interface

ipworksssl_wsserver_set($res, 8, $value , $connectionid);

Default Value

''

Remarks

This property contains a string of data to be sent to the remote host. Write-only property.

Assigning a string to the WSConnectionDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is write-only and not available at design time.

Data Type

Binary String

WSConnectionHost Property (IPWorksSSL_WSServer Class)

The Host header value of the connected client.

Object Oriented Interface

public function getWSConnectionHost($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 9 , $connectionid);

Default Value

''

Remarks

The Host header value of the connected client.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionLineMode Property (IPWorksSSL_WSServer Class)

When LineMode is false (default), the class will fire the DataIn event once for each message received from the server.

Object Oriented Interface

public function getWSConnectionLineMode($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 10 , $connectionid);

Default Value

false

Remarks

When WSConnectionLineMode is false (default), the component will fire the DataIn event once for each message received from the server. When LineMode is True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength configuration setting.

Note: This property is read-only, and should be set through the ChangeLineMode method.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

WSConnectionLocalAddress Property (IPWorksSSL_WSServer Class)

This property shows the IP address of the interface through which the connection is passing.

Object Oriented Interface

public function getWSConnectionLocalAddress($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 11 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the interface through which the connection is passing.

WSConnectionLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionOrigin Property (IPWorksSSL_WSServer Class)

The Origin header value of the connected client.

Object Oriented Interface

public function getWSConnectionOrigin($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 12 , $connectionid);

Default Value

''

Remarks

The Origin header value of the connected client.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionReadyToSend Property (IPWorksSSL_WSServer Class)

This indicates whether the class is ready to send data.

Object Oriented Interface

public function getWSConnectionReadyToSend($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 13 , $connectionid);

Default Value

false

Remarks

This indicates whether the class is ready to send data.

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects but will become False after a failed WSConnectionDataToSend.

After a failed WSConnectionDataToSend, the ReadyToSend event will fire and this property will be True when data can be sent again.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

WSConnectionRemoteHost Property (IPWorksSSL_WSServer Class)

This property shows the IP address of the connected client.

Object Oriented Interface

public function getWSConnectionRemoteHost($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 14 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the connected client.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionRemotePort Property (IPWorksSSL_WSServer Class)

This property shows the port of the connected client.

Object Oriented Interface

public function getWSConnectionRemotePort($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 15 , $connectionid);

Default Value

0

Remarks

This property shows the port of the connected client.

The connection must be valid or an error will be fired.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

WSConnectionRequestHeaders Property (IPWorksSSL_WSServer Class)

The HTTP headers sent by the client in the initial WebSocket connection request.

Object Oriented Interface

public function getWSConnectionRequestHeaders($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 16 , $connectionid);

Default Value

''

Remarks

The HTTP headers sent by the client in the initial WebSocket connection request.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionRequestURI Property (IPWorksSSL_WSServer Class)

The requested URI sent by the client in the initial WebSocket connection request.

Object Oriented Interface

public function getWSConnectionRequestURI($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 17 , $connectionid);

Default Value

''

Remarks

The requested URI sent by the client in the initial WebSocket connection request.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionSubProtocols Property (IPWorksSSL_WSServer Class)

The subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

Object Oriented Interface

public function getWSConnectionSubProtocols($connectionid);

Procedural Interface

ipworksssl_wsserver_get($res, 18 , $connectionid);

Default Value

''

Remarks

The subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

WSConnectionTimeout Property (IPWorksSSL_WSServer Class)

This property specifies a timeout for the class.

Object Oriented Interface

public function getWSConnectionTimeout($connectionid);


public function setWSConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksssl_wsserver_get($res, 19 , $connectionid);


ipworksssl_wsserver_set($res, 19, $value , $connectionid);

Default Value

0

Remarks

This property specifies a timeout for the class.

If the WSConnectionTimeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If WSConnectionTimeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of WSConnectionTimeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the WSConnectionTimeout property is 0 (asynchronous operation).

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (IPWorksSSL_WSServer Class)

An initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getDefaultTimeout();


public function setDefaultTimeout($value);

Procedural Interface

ipworksssl_wsserver_get($res, 21 );


ipworksssl_wsserver_set($res, 21, $value );

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer

Listening Property (IPWorksSSL_WSServer Class)

If set to True, the class accepts incoming connections on LocalPort.

Object Oriented Interface

public function getListening();


public function setListening($value);

Procedural Interface

ipworksssl_wsserver_get($res, 22 );


ipworksssl_wsserver_set($res, 22, $value );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (IPWorksSSL_WSServer Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

ipworksssl_wsserver_get($res, 23 );


ipworksssl_wsserver_set($res, 23, $value );

Default Value

''

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPWorksSSL_WSServer Class)

This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksssl_wsserver_get($res, 24 );


ipworksssl_wsserver_set($res, 24, $value );

Default Value

0

Remarks

This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

Data Type

Integer

SSLAuthenticateClients Property (IPWorksSSL_WSServer Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface

public function getSSLAuthenticateClients();


public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksssl_wsserver_get($res, 25 );


ipworksssl_wsserver_set($res, 25, $value );

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEncoded Property (IPWorksSSL_WSServer Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksssl_wsserver_get($res, 27 );


ipworksssl_wsserver_set($res, 27, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IPWorksSSL_WSServer Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksssl_wsserver_get($res, 43 );


ipworksssl_wsserver_set($res, 43, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksSSL_WSServer Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

ipworksssl_wsserver_get($res, 44 );


ipworksssl_wsserver_set($res, 44, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorksSSL_WSServer Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksssl_wsserver_get($res, 45 );


ipworksssl_wsserver_set($res, 45, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (IPWorksSSL_WSServer Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksssl_wsserver_get($res, 46 );


ipworksssl_wsserver_set($res, 46, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ChangeLineMode Method (IPWorksSSL_WSServer Class)

Controls whether the class will fire DataIn when an EOL is received for the specified connection.

Object Oriented Interface

public function doChangeLineMode($connectionid, $linemode);

Procedural Interface

ipworksssl_wsserver_do_changelinemode($res, $connectionid, $linemode);

Remarks

When WSConnectionLineMode is set to false (default), the component will fire the DataIn event once for each message received from the client. When LineMode is set to True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength[ConnectionId]; configuration setting.

Note: This method is offered as a convenience feature, and has no effect on the behavior of the WebSocket protocol.

Config Method (IPWorksSSL_WSServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksssl_wsserver_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (IPWorksSSL_WSServer Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksssl_wsserver_do_disconnect($res, $connectionid);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (IPWorksSSL_WSServer Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksssl_wsserver_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (IPWorksSSL_WSServer Class)

Interrupts a synchronous send to the remote host.

Object Oriented Interface

public function doInterrupt($connectionid);

Procedural Interface

ipworksssl_wsserver_do_interrupt($res, $connectionid);

Remarks

This property is called using the Connection ID if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection ID until it is completed.

Ping Method (IPWorksSSL_WSServer Class)

Sends a Ping request to the remote host.

Object Oriented Interface

public function doPing($connectionid);

Procedural Interface

ipworksssl_wsserver_do_ping($res, $connectionid);

Remarks

This method sends a Ping request to the remote host and waits for a corresponding Pong response.

The Timeout property specifies how long to wait for the Pong response.

Send Method (IPWorksSSL_WSServer Class)

Sends binary data to the client.

Object Oriented Interface

public function doSend($connectionid, $data);

Procedural Interface

ipworksssl_wsserver_do_send($res, $connectionid, $data);

Remarks

This method sends the binary data specified by Data to the client specified by ConnectionId.

SendBytes Method (IPWorksSSL_WSServer Class)

This method sends binary data to the specified client.

Object Oriented Interface

public function doSendBytes($connectionid, $data);

Procedural Interface

ipworksssl_wsserver_do_sendbytes($res, $connectionid, $data);

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When WSConnectionTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When WSConnectionTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendFile Method (IPWorksSSL_WSServer Class)

This method sends the file to the remote host.

Object Oriented Interface

public function doSendFile($connectionid, $filename);

Procedural Interface

ipworksssl_wsserver_do_sendfile($res, $connectionid, $filename);

Remarks

This method sends the file to the client specified by the ConnectionId.

SendText Method (IPWorksSSL_WSServer Class)

Sends text data to the client.

Object Oriented Interface

public function doSendText($connectionid, $text);

Procedural Interface

ipworksssl_wsserver_do_sendtext($res, $connectionid, $text);

Remarks

This method sends text to the client identified by ConnectionId. To send binary data, use the SendBytes method instead.

When WSConnectionTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

This method sends text to the client identified by ConnectionId. Data sent with this method will always be treated as text data regardless of the value of WSConnectionDataFormat. The class will UTF-8 encode the supplied text.

Shutdown Method (IPWorksSSL_WSServer Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksssl_wsserver_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (IPWorksSSL_WSServer Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksssl_wsserver_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (IPWorksSSL_WSServer Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksssl_wsserver_do_stoplistening($res);

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (IPWorksSSL_WSServer Class)

Fired when a WebSocket is successfully opened.

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'connectionid'

Remarks

The Connected event is fired when a WebSocket is successfully opened on a connection.

ConnectionId identifies the connection.

ConnectionRequest Event (IPWorksSSL_WSServer Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

DataIn Event (IPWorksSSL_WSServer Class)

Fired when data is received.

Object Oriented Interface

public function fireDataIn($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 3, array($this, 'fireDataIn'));

Parameter List

 'connectionid'
 'dataformat'
 'text'
 'eom'
 'eol'

Remarks

The DataIn event provides the data received from the client identified by the ConnectionId parameter.

The incoming data is provided through the Text parameter.

The DataFormat parameter identifies the encoding (if any) of the data. Possible value are:

The EOM parameter stands for End Of Message. By default the class will fire the DataIn event as data is received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is true within the event this indicates the current fragment is also the final fragment of the message. The class may also be configured to buffer the message internally until the complete message is received. To enable this set BufferMessage to true.

The EOL parameter stands for End of Line. When LineMode is false, EOL will always be false. When LineMode is true, EOL will be True if the DataIn event fired because an EOL was received, and false if the DataIn event fired because MaxLineLength was reached.

Disconnected Event (IPWorksSSL_WSServer Class)

Fired when a WebSocket connection is disconnected.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

When the connection is closed the StatusCode parameter may be used to determine if the disconnect occurred normally or if there was an error condition. If the connection is closed normally the StatusCode will be 1000. The Description parameter will contain a textual description returned by the server. Common StatusCode values are:

Error Event (IPWorksSSL_WSServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ConnectionId contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksSSL_WSServer Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

The value 3 (Debug) logs additional debug information (if available).

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

• "Info"
• "Error"
• "Verbose"
• "Debug"

Ping Event (IPWorksSSL_WSServer Class)

Fired when a ping request or response is received.

Object Oriented Interface

public function firePing($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 7, array($this, 'firePing'));

Parameter List

 'connectionid'
 'payload'
 'response'

Remarks

This event fires when a ping request or response is received from the client identified by the ConnectionId parameter. This event is informational only. When the class receives a ping request it will automatically reply with a pong.

Payload holds the payload of the request, if any.

Response is true if the incoming packet is a ping response. If the incoming packet is a ping request this is false.

ReadyToSend Event (IPWorksSSL_WSServer Class)

This event is fired when the class is ready to send data.

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 8, array($this, 'fireReadyToSend'));

Parameter List

 'connectionid'

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed DataToSend. This event is also fired immediately after a connection is established.

SSLClientAuthentication Event (IPWorksSSL_WSServer Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 9, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (IPWorksSSL_WSServer Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 10, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLStatus Event (IPWorksSSL_WSServer Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

WebSocketOpenRequest Event (IPWorksSSL_WSServer Class)

Fired when a client attempts to open a WebSocket.

Object Oriented Interface

public function fireWebSocketOpenRequest($param);

Procedural Interface

ipworksssl_wsserver_register_callback($res, 12, array($this, 'fireWebSocketOpenRequest'));

Parameter List

 'connectionid'
 'requesturi'
 'hostheader'
 'originheader'
 'subprotocols'
 'extensions'
 'requestheaders'
 'statuscode'
 'responseheaders'

Remarks

This event fires when a client connects. It provides an opportunity to inspect the WebSocket request and either accept or reject the connection attempt.

By default, the class will accept the connection. You do not need to set anything to accept the connection. The class will return a StatusCode of 101 to the connecting client and the request will proceed as normal. To reject a connection, set StatusCode to an HTTP error code, such as 401.

ConnectionId identifies the connecting client.

RequestURI provides the URI requested by the connecting client. This may be used to implement logic to select appropriate SubProtocols or determine if the connection should be accepted based on access restrictions to the URI.

HostHeader holds the value of the Host header sent by the client.

OriginHeader holds the value of the Origin header sent by the client.

SubProtocols holds a comma separated list of subprotocols sent by the client (if any). Set SubProtocols to the selected value from the list sent by the client. The class will return this value to the client as the subprotocol the server has selected.

Extensions provides a list of extensions supported by the client.

RequestHeaders contains the HTTP headers sent in the request by the connecting client.

StatusCode determines success or failure. The value 101 (default) indicates success. This may be set to any HTTP status code. For instance a value of 401 indicates an authorization failure.

ResponseHeaders may be set to include additional headers in the response. This is typically used when rejecting a request. For instance when StatusCode is set to 401 you might set ResponseHeaders to "WWW-Authenticate: Basic realm="Secure Realm"" to request authorization from the connecting client.

Config Settings (WSServer Class)

WebSocketServer Config Settings

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (WSServer Class)

WSServer Errors

SSLServer Errors

SSL Errors

TCP/IP Errors