WSServer Class

Properties   Methods   Events   Config Settings   Errors  

The WSServer class is used to create a WebSocket server.

Syntax

WSServer

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Unicode (Windows)
INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);

int ipworksssl_wsserver_getconnectionbacklog(void* lpObj);
int ipworksssl_wsserver_setconnectionbacklog(void* lpObj, int iConnectionBacklog);

int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

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 (WSServer Class)

The number of records in the WSConnection arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionCount();

Unicode (Windows)
INT GetWSConnectionCount();

int ipworksssl_wsserver_getwsconnectioncount(void* lpObj);

int GetWSConnectionCount();

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionAcceptData(int iConnectionId);
int SetWSConnectionAcceptData(int iConnectionId, int bWSConnectionAcceptData);

Unicode (Windows)
BOOL GetWSConnectionAcceptData(INT iConnectionId);
INT SetWSConnectionAcceptData(INT iConnectionId, BOOL bWSConnectionAcceptData);

int ipworksssl_wsserver_getwsconnectionacceptdata(void* lpObj, int connectionid);
int ipworksssl_wsserver_setwsconnectionacceptdata(void* lpObj, int connectionid, int bWSConnectionAcceptData);

bool GetWSConnectionAcceptData(int iConnectionId);
int SetWSConnectionAcceptData(int iConnectionId, bool bWSConnectionAcceptData);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionBytesSent(int iConnectionId);

Unicode (Windows)
INT GetWSConnectionBytesSent(INT iConnectionId);

int ipworksssl_wsserver_getwsconnectionbytessent(void* lpObj, int connectionid);

int GetWSConnectionBytesSent(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionConnected(int iConnectionId);
int SetWSConnectionConnected(int iConnectionId, int bWSConnectionConnected);

Unicode (Windows)
BOOL GetWSConnectionConnected(INT iConnectionId);
INT SetWSConnectionConnected(INT iConnectionId, BOOL bWSConnectionConnected);

int ipworksssl_wsserver_getwsconnectionconnected(void* lpObj, int connectionid);
int ipworksssl_wsserver_setwsconnectionconnected(void* lpObj, int connectionid, int bWSConnectionConnected);

bool GetWSConnectionConnected(int iConnectionId);
int SetWSConnectionConnected(int iConnectionId, bool bWSConnectionConnected);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionConnectionId(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionConnectionId(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionconnectionid(void* lpObj, int connectionid);

QString GetWSConnectionConnectionId(int iConnectionId);

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 (WSServer Class)

The format of the data being sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionDataFormat(int iConnectionId);
int SetWSConnectionDataFormat(int iConnectionId, int iWSConnectionDataFormat);

Unicode (Windows)
INT GetWSConnectionDataFormat(INT iConnectionId);
INT SetWSConnectionDataFormat(INT iConnectionId, INT iWSConnectionDataFormat);

DF_AUTOMATIC(0), 
DF_TEXT(1), 
DF_BINARY(2), 
DF_PING(9), 
DF_PONG(10)

int ipworksssl_wsserver_getwsconnectiondataformat(void* lpObj, int connectionid);
int ipworksssl_wsserver_setwsconnectiondataformat(void* lpObj, int connectionid, int iWSConnectionDataFormat);

int GetWSConnectionDataFormat(int iConnectionId);
int SetWSConnectionDataFormat(int iConnectionId, int iWSConnectionDataFormat);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetWSConnectionDataToSend(int iConnectionId, const char* lpWSConnectionDataToSend, int lenWSConnectionDataToSend);

Unicode (Windows)
INT SetWSConnectionDataToSend(INT iConnectionId, LPCSTR lpWSConnectionDataToSend, INT lenWSConnectionDataToSend);

int ipworksssl_wsserver_setwsconnectiondatatosend(void* lpObj, int connectionid, const char* lpWSConnectionDataToSend, int lenWSConnectionDataToSend);

int SetWSConnectionDataToSend(int iConnectionId, QByteArray qbaWSConnectionDataToSend);

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 (WSServer Class)

The Host header value of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionHost(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionHost(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionhost(void* lpObj, int connectionid);

QString GetWSConnectionHost(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionLineMode(int iConnectionId);

Unicode (Windows)
BOOL GetWSConnectionLineMode(INT iConnectionId);

int ipworksssl_wsserver_getwsconnectionlinemode(void* lpObj, int connectionid);

bool GetWSConnectionLineMode(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionLocalAddress(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionLocalAddress(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionlocaladdress(void* lpObj, int connectionid);

QString GetWSConnectionLocalAddress(int iConnectionId);

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 (WSServer Class)

The Origin header value of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionOrigin(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionOrigin(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionorigin(void* lpObj, int connectionid);

QString GetWSConnectionOrigin(int iConnectionId);

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 (WSServer Class)

This indicates whether the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionReadyToSend(int iConnectionId);

Unicode (Windows)
BOOL GetWSConnectionReadyToSend(INT iConnectionId);

int ipworksssl_wsserver_getwsconnectionreadytosend(void* lpObj, int connectionid);

bool GetWSConnectionReadyToSend(int iConnectionId);

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 (WSServer Class)

This property shows the IP address of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionRemoteHost(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionRemoteHost(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionremotehost(void* lpObj, int connectionid);

QString GetWSConnectionRemoteHost(int iConnectionId);

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 (WSServer Class)

This property shows the port of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionRemotePort(int iConnectionId);

Unicode (Windows)
INT GetWSConnectionRemotePort(INT iConnectionId);

int ipworksssl_wsserver_getwsconnectionremoteport(void* lpObj, int connectionid);

int GetWSConnectionRemotePort(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionRequestHeaders(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionRequestHeaders(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionrequestheaders(void* lpObj, int connectionid);

QString GetWSConnectionRequestHeaders(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionRequestURI(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionRequestURI(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionrequesturi(void* lpObj, int connectionid);

QString GetWSConnectionRequestURI(int iConnectionId);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWSConnectionSubProtocols(int iConnectionId);

Unicode (Windows)
LPWSTR GetWSConnectionSubProtocols(INT iConnectionId);

char* ipworksssl_wsserver_getwsconnectionsubprotocols(void* lpObj, int connectionid);

QString GetWSConnectionSubProtocols(int iConnectionId);

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 (WSServer Class)

This property specifies a timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWSConnectionTimeout(int iConnectionId);
int SetWSConnectionTimeout(int iConnectionId, int iWSConnectionTimeout);

Unicode (Windows)
INT GetWSConnectionTimeout(INT iConnectionId);
INT SetWSConnectionTimeout(INT iConnectionId, INT iWSConnectionTimeout);

int ipworksssl_wsserver_getwsconnectiontimeout(void* lpObj, int connectionid);
int ipworksssl_wsserver_setwsconnectiontimeout(void* lpObj, int connectionid, int iWSConnectionTimeout);

int GetWSConnectionTimeout(int iConnectionId);
int SetWSConnectionTimeout(int iConnectionId, int iWSConnectionTimeout);

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 (WSServer Class)

An initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);

int ipworksssl_wsserver_getdefaulttimeout(void* lpObj);
int ipworksssl_wsserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworksssl_wsserver_getlistening(void* lpObj);
int ipworksssl_wsserver_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksssl_wsserver_getlocalhost(void* lpObj);
int ipworksssl_wsserver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksssl_wsserver_getlocalport(void* lpObj);
int ipworksssl_wsserver_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int ipworksssl_wsserver_getsslauthenticateclients(void* lpObj);
int ipworksssl_wsserver_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

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 (WSServer Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksssl_wsserver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_wsserver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksssl_wsserver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_wsserver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

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 (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.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksssl_wsserver_getsslcertstorepassword(void* lpObj);
int ipworksssl_wsserver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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 (WSServer Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksssl_wsserver_getsslcertstoretype(void* lpObj);
int ipworksssl_wsserver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksssl_wsserver_getsslcertsubject(void* lpObj);
int ipworksssl_wsserver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeLineMode(int iConnectionId, int bLineMode);

Unicode (Windows)
INT ChangeLineMode(INT iConnectionId, BOOL bLineMode);

int ipworksssl_wsserver_changelinemode(void* lpObj, int iConnectionId, int bLineMode);

int ChangeLineMode(int iConnectionId, bool bLineMode);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (WSServer Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksssl_wsserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (WSServer Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksssl_wsserver_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (WSServer Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssl_wsserver_doevents(void* lpObj);

int DoEvents();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (WSServer Class)

Interrupts a synchronous send to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt(int iConnectionId);

Unicode (Windows)
INT Interrupt(INT iConnectionId);

int ipworksssl_wsserver_interrupt(void* lpObj, int iConnectionId);

int Interrupt(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Ping Method (WSServer Class)

Sends a Ping request to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Ping(int iConnectionId);

Unicode (Windows)
INT Ping(INT iConnectionId);

int ipworksssl_wsserver_ping(void* lpObj, int iConnectionId);

int Ping(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Send Method (WSServer Class)

Sends binary data to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Send(int iConnectionId, const char* lpData, int lenData);

Unicode (Windows)
INT Send(INT iConnectionId, LPCSTR lpData, INT lenData);

int ipworksssl_wsserver_send(void* lpObj, int iConnectionId, const char* lpData, int lenData);

int Send(int iConnectionId, QByteArray qbaData);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendBytes Method (WSServer Class)

This method sends binary data to the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendBytes(int iConnectionId, const char* lpData, int lenData);

Unicode (Windows)
INT SendBytes(INT iConnectionId, LPCSTR lpData, INT lenData);

int ipworksssl_wsserver_sendbytes(void* lpObj, int iConnectionId, const char* lpData, int lenData);

int SendBytes(int iConnectionId, QByteArray qbaData);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendFile Method (WSServer Class)

This method sends the file to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(int iConnectionId, const char* lpszFileName);

Unicode (Windows)
INT SendFile(INT iConnectionId, LPCWSTR lpszFileName);

int ipworksssl_wsserver_sendfile(void* lpObj, int iConnectionId, const char* lpszFileName);

int SendFile(int iConnectionId, const QString& qsFileName);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendText Method (WSServer Class)

Sends text data to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendText(int iConnectionId, const char* lpszText);

Unicode (Windows)
INT SendText(INT iConnectionId, LPCWSTR lpszText);

int ipworksssl_wsserver_sendtext(void* lpObj, int iConnectionId, const char* lpszText);

int SendText(int iConnectionId, const QString& qsText);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Shutdown Method (WSServer Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksssl_wsserver_shutdown(void* lpObj);

int Shutdown();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (WSServer Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksssl_wsserver_startlistening(void* lpObj);

int StartListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (WSServer Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksssl_wsserver_stoplistening(void* lpObj);

int StopListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (WSServer Class)

Fired when a WebSocket is successfully opened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(WSServerConnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int reserved;
} WSServerConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(WSServerConnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT reserved;
} WSServerConnectedEventParams;

#define EID_WSSERVER_CONNECTED 1

virtual INT IPWORKSSSL_CALL FireConnected(INT &iConnectionId);

class WSServerConnectedEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(WSServerConnectedEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireConnected(WSServerConnectedEventParams *e) {...}

Remarks

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

ConnectionId identifies the connection.

ConnectionRequest Event (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(WSServerConnectionRequestEventParams *e);

typedef struct {
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} WSServerConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(WSServerConnectionRequestEventParams *e);

typedef struct {
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} WSServerConnectionRequestEventParams;

#define EID_WSSERVER_CONNECTIONREQUEST 2

virtual INT IPWORKSSSL_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class WSServerConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionRequest(WSServerConnectionRequestEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireConnectionRequest(WSServerConnectionRequestEventParams *e) {...}

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 (WSServer Class)

Fired when data is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDataIn(WSServerDataInEventParams *e);

typedef struct {
  int ConnectionId;
  int DataFormat;
  const char *Text;
  int lenText;
  int EOM;
  int EOL;
  int reserved;
} WSServerDataInEventParams;


Unicode (Windows)
virtual INT FireDataIn(WSServerDataInEventParams *e);

typedef struct {
  INT ConnectionId;
  INT DataFormat;
  LPCSTR Text;
  INT lenText;
  BOOL EOM;
  BOOL EOL;
  INT reserved;
} WSServerDataInEventParams;

#define EID_WSSERVER_DATAIN 3

virtual INT IPWORKSSSL_CALL FireDataIn(INT &iConnectionId, INT &iDataFormat, LPSTR &lpText, INT &lenText, BOOL &bEOM, BOOL &bEOL);

class WSServerDataInEventParams {
public:
  int ConnectionId();

  int DataFormat();

  const QByteArray &Text();

  bool EOM();

  bool EOL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DataIn(WSServerDataInEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireDataIn(WSServerDataInEventParams *e) {...}

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 (WSServer Class)

Fired when a WebSocket connection is disconnected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(WSServerDisconnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} WSServerDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(WSServerDisconnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} WSServerDisconnectedEventParams;

#define EID_WSSERVER_DISCONNECTED 4

virtual INT IPWORKSSSL_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class WSServerDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(WSServerDisconnectedEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireDisconnected(WSServerDisconnectedEventParams *e) {...}

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 (WSServer Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(WSServerErrorEventParams *e);

typedef struct {
  int ConnectionId;
  int ErrorCode;
  const char *Description;
  int reserved;
} WSServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(WSServerErrorEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} WSServerErrorEventParams;

#define EID_WSSERVER_ERROR 5

virtual INT IPWORKSSSL_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class WSServerErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(WSServerErrorEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireError(WSServerErrorEventParams *e) {...}

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 (WSServer Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(WSServerLogEventParams *e);

typedef struct {
  int ConnectionId;
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} WSServerLogEventParams;


Unicode (Windows)
virtual INT FireLog(WSServerLogEventParams *e);

typedef struct {
  INT ConnectionId;
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} WSServerLogEventParams;

#define EID_WSSERVER_LOG 6

virtual INT IPWORKSSSL_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class WSServerLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(WSServerLogEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireLog(WSServerLogEventParams *e) {...}

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 (WSServer Class)

Fired when a ping request or response is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePing(WSServerPingEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Payload;
  int lenPayload;
  int Response;
  int reserved;
} WSServerPingEventParams;


Unicode (Windows)
virtual INT FirePing(WSServerPingEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCSTR Payload;
  INT lenPayload;
  BOOL Response;
  INT reserved;
} WSServerPingEventParams;

#define EID_WSSERVER_PING 7

virtual INT IPWORKSSSL_CALL FirePing(INT &iConnectionId, LPSTR &lpPayload, INT &lenPayload, BOOL &bResponse);

class WSServerPingEventParams {
public:
  int ConnectionId();

  const QByteArray &Payload();

  bool Response();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Ping(WSServerPingEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FirePing(WSServerPingEventParams *e) {...}

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(WSServerReadyToSendEventParams *e);

typedef struct {
  int ConnectionId;
  int reserved;
} WSServerReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(WSServerReadyToSendEventParams *e);

typedef struct {
  INT ConnectionId;
  INT reserved;
} WSServerReadyToSendEventParams;

#define EID_WSSERVER_READYTOSEND 8

virtual INT IPWORKSSSL_CALL FireReadyToSend(INT &iConnectionId);

class WSServerReadyToSendEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(WSServerReadyToSendEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireReadyToSend(WSServerReadyToSendEventParams *e) {...}

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(WSServerSSLClientAuthenticationEventParams *e);

typedef struct {
  int ConnectionId;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} WSServerSSLClientAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLClientAuthentication(WSServerSSLClientAuthenticationEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} WSServerSSLClientAuthenticationEventParams;

#define EID_WSSERVER_SSLCLIENTAUTHENTICATION 9

virtual INT IPWORKSSSL_CALL FireSSLClientAuthentication(INT &iConnectionId, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class WSServerSSLClientAuthenticationEventParams {
public:
  int ConnectionId();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLClientAuthentication(WSServerSSLClientAuthenticationEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireSSLClientAuthentication(WSServerSSLClientAuthenticationEventParams *e) {...}

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLConnectionRequest(WSServerSSLConnectionRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *SupportedCipherSuites;
  const char *SupportedSignatureAlgs;
  int CertStoreType;
  char *CertStore;
  char *CertPassword;
  char *CertSubject;
  int reserved;
} WSServerSSLConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireSSLConnectionRequest(WSServerSSLConnectionRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR SupportedCipherSuites;
  LPCWSTR SupportedSignatureAlgs;
  INT CertStoreType;
  LPWSTR CertStore;
  LPWSTR CertPassword;
  LPWSTR CertSubject;
  INT reserved;
} WSServerSSLConnectionRequestEventParams;

#define EID_WSSERVER_SSLCONNECTIONREQUEST 10

virtual INT IPWORKSSSL_CALL FireSSLConnectionRequest(INT &iConnectionId, LPSTR &lpszSupportedCipherSuites, LPSTR &lpszSupportedSignatureAlgs, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);

class WSServerSSLConnectionRequestEventParams {
public:
  int ConnectionId();

  const QString &SupportedCipherSuites();

  const QString &SupportedSignatureAlgs();

  int CertStoreType();
  void SetCertStoreType(int iCertStoreType);

  const QString &CertStore();
  void SetCertStore(const QString &qsCertStore);

  const QString &CertPassword();
  void SetCertPassword(const QString &qsCertPassword);

  const QString &CertSubject();
  void SetCertSubject(const QString &qsCertSubject);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLConnectionRequest(WSServerSSLConnectionRequestEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireSSLConnectionRequest(WSServerSSLConnectionRequestEventParams *e) {...}

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 (WSServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(WSServerSSLStatusEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} WSServerSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(WSServerSSLStatusEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} WSServerSSLStatusEventParams;

#define EID_WSSERVER_SSLSTATUS 11

virtual INT IPWORKSSSL_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);

class WSServerSSLStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(WSServerSSLStatusEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireSSLStatus(WSServerSSLStatusEventParams *e) {...}

Remarks

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

WebSocketOpenRequest Event (WSServer Class)

Fired when a client attempts to open a WebSocket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWebSocketOpenRequest(WSServerWebSocketOpenRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *RequestURI;
  const char *HostHeader;
  const char *OriginHeader;
  char *SubProtocols;
  const char *Extensions;
  const char *RequestHeaders;
  int StatusCode;
  char *ResponseHeaders;
  int reserved;
} WSServerWebSocketOpenRequestEventParams;


Unicode (Windows)
virtual INT FireWebSocketOpenRequest(WSServerWebSocketOpenRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR RequestURI;
  LPCWSTR HostHeader;
  LPCWSTR OriginHeader;
  LPWSTR SubProtocols;
  LPCWSTR Extensions;
  LPCWSTR RequestHeaders;
  INT StatusCode;
  LPWSTR ResponseHeaders;
  INT reserved;
} WSServerWebSocketOpenRequestEventParams;

#define EID_WSSERVER_WEBSOCKETOPENREQUEST 12

virtual INT IPWORKSSSL_CALL FireWebSocketOpenRequest(INT &iConnectionId, LPSTR &lpszRequestURI, LPSTR &lpszHostHeader, LPSTR &lpszOriginHeader, LPSTR &lpszSubProtocols, LPSTR &lpszExtensions, LPSTR &lpszRequestHeaders, INT &iStatusCode, LPSTR &lpszResponseHeaders);

class WSServerWebSocketOpenRequestEventParams {
public:
  int ConnectionId();

  const QString &RequestURI();

  const QString &HostHeader();

  const QString &OriginHeader();

  const QString &SubProtocols();
  void SetSubProtocols(const QString &qsSubProtocols);

  const QString &Extensions();

  const QString &RequestHeaders();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  const QString &ResponseHeaders();
  void SetResponseHeaders(const QString &qsResponseHeaders);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void WebSocketOpenRequest(WSServerWebSocketOpenRequestEventParams *e);

// Or, subclass WSServer and override this emitter function.
virtual int FireWebSocketOpenRequest(WSServerWebSocketOpenRequestEventParams *e) {...}

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)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

WSServer Errors

SSLServer Errors

SSL Errors

TCP/IP Errors