WSServer Class
Properties Methods Events Config Settings Errors
The WSServer class is used to create a WebSocket server.
Syntax
WSServer
Remarks
The WSServer class provides an easy way to accept connections from WebSocket clients and transfer data.
The WSServer class is a server that accepts incoming WebSocket connections and provides an easy way to send and receive data over the connection.
To begin using the class first specify a valid value for LocalPort. This is the port on which incoming connections will be accepted. To begin listening set Listening to True.
When a client connects the WebSocketOpenRequest event will fire. To accept the connection simply allow the event to complete. To reject the request set the StatusCode parameter to an HTTP error code (such as 401).
Once the connection is received incoming data will be provide through the DataIn event. To send data to a client you may use the Send, SendText, or SendFile methods. You may also set WSConnectionDataToSend.
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.
ConnectionBacklog | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. |
WSConnectionCount | The number of records in the WSConnection arrays. |
WSConnectionAcceptData | Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection. |
WSConnectionBytesSent | This property shows how many bytes were sent after the last assignment to DataToSend . |
WSConnectionConnected | This property is used to disconnect individual connections and/or show their status. |
WSConnectionConnectionId | This property contains an identifier generated by the class to identify each connection. |
WSConnectionDataFormat | The format of the data being sent. |
WSConnectionDataToSend | This property contains a string of data to be sent to the remote host. |
WSConnectionHost | The Host header value of the connected client. |
WSConnectionLineMode | When LineMode is false (default), the class will fire the DataIn event once for each message received from the server. |
WSConnectionLocalAddress | This property shows the IP address of the interface through which the connection is passing. |
WSConnectionOrigin | The Origin header value of the connected client. |
WSConnectionReadyToSend | This indicates whether the class is ready to send data. |
WSConnectionRemoteHost | This property shows the IP address of the connected client. |
WSConnectionRemotePort | This property shows the port of the connected client. |
WSConnectionRequestHeaders | The HTTP headers sent by the client in the initial WebSocket connection request. |
WSConnectionRequestURI | The requested URI sent by the client in the initial WebSocket connection request. |
WSConnectionSubProtocols | The subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request. |
WSConnectionTimeout | This property specifies a timeout for the class. |
DefaultTimeout | An initial timeout value to be used by incoming connections. |
Listening | If set to True, the class accepts incoming connections on LocalPort. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. |
SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
ChangeLineMode | Controls whether the class will fire DataIn when an EOL is received for the specified connection. |
Config | Sets or retrieves a configuration setting. |
Disconnect | This method disconnects the specified client. |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupts a synchronous send to the remote host. |
Ping | Sends a Ping request to the remote host. |
Send | Sends binary data to the client. |
SendBytes | This method sends binary data to the specified client. |
SendFile | This method sends the file to the remote host. |
SendText | Sends text data to the client. |
Shutdown | This method shuts down the server. |
StartListening | This method starts listening for incoming connections. |
StopListening | This method stops listening for new connections. |
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.
Connected | Fired when a WebSocket is successfully opened. |
ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
DataIn | Fired when data is received. |
Disconnected | Fired when a WebSocket connection is disconnected. |
Error | Information about errors during data delivery. |
Log | Fires once for each log message. |
Ping | Fired when a ping request or response is received. |
ReadyToSend | This event is fired when the class is ready to send data. |
SSLClientAuthentication | This event is fired when the client presents its credentials to the server. |
SSLConnectionRequest | This event fires when a Secure Sockets Layer (SSL) connection is requested. |
SSLStatus | This event is fired to show the progress of the secure connection. |
WebSocketOpenRequest | Fired when a client attempts to open a WebSocket. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
BufferMessage | Indicates whether or not the entire message is buffered before firing the DataIn event. |
DisconnectStatusCode | Specifies the status code when closing a connection. |
DisconnectStatusDescription | Specifies the message associated with the disconnect status code. |
EnablePermessageDeflate | Determines whether or not the class will enable the permessage-deflate extension. |
MaxFrameSize | Specifies the maximum size of the outgoing message in bytes before fragmentation occurs. |
MaxLineLength[ConnectionId] | Determines the maximum line length for a connection when LineMode is True. |
MessageLength[ConnectionId] | The length of the message (in bytes) when sending asynchronously. |
WaitForCloseResponse | Determines whether or not the class will forcibly close a connection. |
AllowedClients | A comma-separated list of host names or IP addresses that can access the class. |
BindExclusively | Whether or not the class considers a local port reserved for exclusive use. |
BlockedClients | A comma-separated list of host names or IP addresses that cannot access the class. |
ConnectionUID | The unique connectionId for a connection. |
DefaultConnectionTimeout | The inactivity timeout applied to the SSL handshake. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
MaxConnections | The maximum number of connections available. |
MaxReadTime | The maximum time spent reading data from each connection. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIOCP | Whether to use the completion port I/O model. |
UseIPv6 | Whether to use IPv6. |
UseWindowsMessages | Whether to use the WSAAsyncSelect I/O model. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
ConnectionBacklog Property (WSServer Class)
This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
Syntax
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
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
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) on the connection.
Syntax
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) on 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
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 Timeout 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
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
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
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);
Possible Values
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:
0 (dfAutomatic - default) | The class will attempt to automatically determine the correct data format. This is suitable for most cases. |
1 (dfText) | The class will UTF-8 encode the specified data before sending. Data that has already been UTF-8 encoded may also be supplied. |
2 (dfBinary) | The class will send the data exactly as it is provided. |
9 (dfPing) | The class will send the ping with data exactly as it is provided. |
10 (dfPong) | The class will send the pong with data exactly as it is provided. |
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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. PKCS12 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
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
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (WSServer Class)
This is the subject of the certificate used for client authentication.
Syntax
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 properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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:
0 | If LineMode is disabled, a value of 0 indicates a continuation packet. If LineMode is enabled the value will always be 0, regardless of packet type. |
1 | The data is UTF-8 encoded. |
2 | The data is binary and has no encoding. |
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
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:
1000 (default) | Normal closure. |
1001 | The resource is going away. For instance the server is shutting down or a browser is navigating away from the page. |
1002 | A protocol error occurred. |
1003 | Unexpected data was received (e.g., an endpoint that only accepts text data could send this if binary data is received). |
1007 | Invalid payload data was received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this). |
1008 | A generic code that indicates the endpoint received a message that violates its policy. |
1009 | A message that was too large was received. |
1010 | A required extension could not be negotiated. |
1011 | An unexpected error occurred. |
Error Event (WSServer Class)
Information about errors during data delivery.
Syntax
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
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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data is logged. |
3 (Debug) | Debug data is logged. |
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
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
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
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
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
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 are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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. PKCS12 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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
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
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)
The class accepts one or more of the following configuration settings. Configuration 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.WebSocketServer Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BufferMessage: Indicates whether or not the entire message is buffered before firing the DataIn event.When receiving large messages the DataIn event may fire multiple times to provide data as it is received in each message fragment. When BufferMessage is set to True the class will internally buffer the message as it is received until it is complete before firing the DataIn event. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DisconnectStatusCode:
Specifies the status code when closing a connection.When the Disconnect method is called the class will send the status code specified here. By default the
value is 1000 which indicates a normal closure. Any other value represents an error condition. You may set
any value you wish, however the protocol defines the following common values.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DisconnectStatusDescription: Specifies the message associated with the disconnect status code.This setting may be used to provide a textual description of the status code sent when closing the connection. This setting works in conjunction with DisconnectStatusCode. For any of the standard codes listed in DisconnectStatusCode the class will use a default description that may be overridden with this setting. For any non-standard codes that are not listed, this setting should be set or no description will be sent. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnablePermessageDeflate:
Determines whether or not the class will enable the permessage-deflate extension.When true , the class will allow the permessage-deflate extension to be enabled, if the WebSocket client requests the permessage-deflate extension.
When this setting is set to false, the class will keep the permessage-deflate extenstion disabled, regardless of what the WebSocket client requests.
The default value is true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxFrameSize:
Specifies the maximum size of the outgoing message in bytes before fragmentation occurs.This setting specifies the maximum size of the outgoing message in bytes before fragmentation will occur. When a message
that is larger than MaxFrameSize is sent, it will be broken into fragments with the maximum size
specified here. The default value is 131072 (128K).
When a message is fragmented, the receiving side may check the EOM parameter of the DataIn event to determine when the message is complete. Note: When Timeout is set to 0 messages that are fragmented are always sent as individual smaller messages and EOM will always be True in the DataIn event on the receiving side. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength[ConnectionId]: Determines the maximum line length for a connection when LineMode is True.When WSConnectionLineMode is true, setting this will cause the component to fire the DataIn event when the length of the received data reaches the value of this setting. When the DataIn event fires, the EOL parameter will be False if this setting caused the event to fire and True if an EOL caused the event to fire. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MessageLength[ConnectionId]:
The length of the message (in bytes) when sending asynchronously.This setting specifies the length of messages being sent when operating asynchronously.
When DefaultTimeout is set to 0 the class operates asynchronously and by default all data sent when Send is called or WSConnectionDataToSend is set is considered a complete message. Each packet leaving the class has the End-of-Message flag set. To send messages which may be fragmented, set MessageLength to the length of the message (in bytes) that is being sent. When set the class will consider the next MessageLength bytes sent as part of a single message and only the last packet will set the End-of-Message flag. This setting is helpful when data is organized into messages and the receiving side expected the End-of-Message flag to signal the end of a message. Note: This setting is only applicable when DefaultTimeout is set to 0. When DefaultTimeout is set to a positive value the message data may be passed in its entirety to WSConnectionDataToSend or Send and will be automatically handled as needed by the class. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WaitForCloseResponse: Determines whether or not the class will forcibly close a connection.When true (default) the class will wait for a response from the client when closing the connection. When this setting is set to false, the class will forcibly close the connection without waiting for a response from the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPServer Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowedClients:
A comma-separated list of host names or IP addresses that can access the class.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the class.
The wildcard character "*" is supported. The default value is "*" and all connections are accepted.
When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will be disconnected. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BindExclusively: Whether or not the component considers a local port reserved for exclusive use.If this is True (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BlockedClients:
A comma-separated list of host names or IP addresses that cannot access the class.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the class.The default value is "" and all connections are accepted.
When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will not be connected. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionUID:
The unique connectionId for a connection.Connection Ids may be reused as clients connect and disconnect. Querying ConnectionUID will return a unique identifier for that connection Id.
If the specified connection Id does not exist, then ConnectionUID will return 0. For example:
Connection5UID = obj.config("ConnectionUID[5]") |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DefaultConnectionTimeout:
The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value,
if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable
to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected
and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied.
Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. InBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.A TCP keep-alive packet will be sent after a period of inactivity, as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
If this value is not specified here, the system default is 1 second.
This setting is applicable to all connections.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveRetryCount:
The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity, as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This setting specifies the number of times that the keep-alive packets will be sent again before the remote host
is considered disconnected. If this value is not specified here, the system default is 9.
Note: This configuration setting is available only in the Unix platform, and it is not supported in macOS or FreeBSD. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxConnections:
The maximum number of connections available.
This is the maximum number of connections available. This property must be set before Listening is set
to True, and once set, it can no longer be changed for the current instance of the class.
The maximum value for this setting is 100,000 connections.
Use this setting with caution. Extremely large values may affect performance.
The default value is 1000.
Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxReadTime:
The maximum time spent reading data from each connection.This setting specifies the maximum time in milliseconds that the class will spend reading data from a particular connection before servicing other connections. When a single client is sending data to the class at a high rate this setting is used to ensure that other connections are serviced in a timely manner. Specifying a positive value prevents a single client from monopolizing the class's resources. The special value of 0 indicates no limit and is generally not recommended.
The default value is 50 (milliseconds). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. OutBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIOCP:
Whether to use the completion port I/O model.The default value is False. When set to True, the class will use an I/O Completion Port (IOCP) to manage operations on sockets. A single completion port allows the asynchronous notification of network events on an entire group of sockets. This property must be set before Listening is set to True.
Nothing else is required to begin accepting IOCP connections. One major benefit to using this model is that there will be no thread blocked waiting for a request to complete. The system notifies the process through an Asynchronous Procedure Call (APC) once the device driver finishes servicing the I/O request. IOCP allows a single I/O worker thread handle multiple clients' input/output "fairly". Note: When set to True, this setting will automatically set UseWindowsMessages to False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. When set to 2, the class will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0.
Possible values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseWindowsMessages:
Whether to use the WSAAsyncSelect I/O model.The default value is True, and the class will receive a Windows message-based notification of network events. Turning on Windows message notifications allows the application to get connect, send, receive, and socket closure network event notifications on a socket. This property must be set before Listening is set to True.
Nothing else is required to begin accepting connections using the Windows message queue. In high-traffic environments, messages will be discarded if the queue is full. Additionally, because a single window procedure will service all events on thousands of sockets, the Windows message queue is not scalable from a performance perspective. If this setting is set to False, the class will instead use the Winsock select model instead. The component supports additional I/O models. Please see UseIOCP for more information. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACertFilePaths:
The paths to CA certificate files on Unix/Linux.This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is: /etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
This functionality is currently not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is false.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseFIPSCompliantAPI:
Tells the class whether or not to use FIPS certified APIs.When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details please see the FIPS 140-2 Compliance article. Note: This setting is only applicable on Windows. Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
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
4202 Error sending data to the connected client. |
SSLServer Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 SSLServer is already listening. | |
106 Cannot change LocalPort when SSLServer is listening. | |
107 Cannot change LocalHost when SSLServer is listening. | |
108 Cannot change MaxConnections when SSLServer is listening. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
126 Invalid ConnectionId. | |
135 Operation would block. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |