SSLServer Class

Properties   Methods   Events   Config Settings   Errors  

The SSLServer Class is a generic Transmission Control Protocol (TCP) server class based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

SSLServer

Remarks

The SSLServer Class supports Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method. The SSLCert properties are used to select a certificate for the server.

Note: A valid certificate MUST be selected before the server can function.

SSLServer is the server complement of SSLClient, which is used to create client applications. They share a common design philosophy and interface. We expect you will find SSLServer to be as easy to use as SSLClient.

By default, each instance of SSLServer can handle up to 1,000 simultaneous incoming connections. This number may be increased up to 100,000 or decreased to a lower value by using the MaxConnections configuration setting.

The connections are identified by a ConnectionId, an Id generated by the component to identify each connection. This Id is unique to each connection. SSLServer's events also include a ConnectionId as a parameter to identify the connection they relate to.

Our main goal in designing SSLServer was to make it easy to use without sacrificing performance. The class has a minimum of properties, and six events: ConnectionRequest, Connected, DataIn, Disconnected, ReadyToSend, and Error.

SSLServer can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to SSLClient. Data are sent by calling the Send method with Text as a parameter. The address and port of the incoming connection can be found by querying the RemoteHost and RemotePort properties.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

ConnectionBacklog Property (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_getconnectionbacklog(void* lpObj);
int ipworksssl_sslserver_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

Connections Property (SSLServer Class)

This property includes a collection of currently connected clients.

Syntax

• C++
• C
• Qt

IPWorksSSLList<IPWorksSSLConnection>* GetConnections();

int ipworksssl_sslserver_getconnectioncount(void* lpObj);

int ipworksssl_sslserver_getacceptdata(void* lpObj, int connectionid);

int ipworksssl_sslserver_getbytessent(void* lpObj, int connectionid);

int ipworksssl_sslserver_getconnected(void* lpObj, int connectionid);

int ipworksssl_sslserver_getconnectionid(void* lpObj, int connectionid);

int ipworksssl_sslserver_geteol(void* lpObj, int connectionid, char** lpEOL, int* lenEOL);
int ipworksssl_sslserver_seteol(void* lpObj, int connectionid, const char* lpEOL, int lenEOL);

int ipworksssl_sslserver_getidletimeout(void* lpObj, int connectionid);
int ipworksssl_sslserver_setidletimeout(void* lpObj, int connectionid, int iIdleTimeout);

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

int ipworksssl_sslserver_getreadytosend(void* lpObj, int connectionid);

int ipworksssl_sslserver_getrecordlength(void* lpObj, int connectionid);

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

int ipworksssl_sslserver_getremoteport(void* lpObj, int connectionid);

int ipworksssl_sslserver_getsinglelinemode(void* lpObj, int connectionid);
int ipworksssl_sslserver_setsinglelinemode(void* lpObj, int connectionid, int bSingleLineMode);

int ipworksssl_sslserver_gettimeout(void* lpObj, int connectionid);
int ipworksssl_sslserver_settimeout(void* lpObj, int connectionid, int iTimeout);

int ipworksssl_sslserver_getuserdata(void* lpObj, int connectionid, char** lpUserData, int* lenUserData);
int ipworksssl_sslserver_setuserdata(void* lpObj, int connectionid, const char* lpUserData, int lenUserData);

int GetConnectionCount();

bool GetAcceptData(int iConnectionId);

int GetBytesSent(int iConnectionId);

bool GetConnected(int iConnectionId);

int GetConnectionId(int iConnectionId);

QByteArray GetEOL(int iConnectionId);
int SetEOL(int iConnectionId, QByteArray qbaEOL);

int GetIdleTimeout(int iConnectionId);
int SetIdleTimeout(int iConnectionId, int iIdleTimeout);

QString GetLocalAddress(int iConnectionId);

bool GetReadyToSend(int iConnectionId);

int GetRecordLength(int iConnectionId);

QString GetRemoteHost(int iConnectionId);

int GetRemotePort(int iConnectionId);

bool GetSingleLineMode(int iConnectionId);
int SetSingleLineMode(int iConnectionId, bool bSingleLineMode);

int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);

QByteArray GetUserData(int iConnectionId);
int SetUserData(int iConnectionId, QByteArray qbaUserData);

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the Connection type.

This collection is a hash-table type of collection, in which the Connection Id string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event.

Example (Broadcasting Data) For i = 0 to Control.ConnectionCount Control.DataToSend(Control.ConnectionId(i)) = "Broadcast Data" Next i

This property is read-only.

Data Type

IPWorksSSLConnection

DefaultEOL Property (SSLServer Class)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultEOL(char* &lpDefaultEOL, int &lenDefaultEOL);
int SetDefaultEOL(const char* lpDefaultEOL, int lenDefaultEOL);

Unicode (Windows)
INT GetDefaultEOL(LPSTR &lpDefaultEOL, INT &lenDefaultEOL);
INT SetDefaultEOL(LPCSTR lpDefaultEOL, INT lenDefaultEOL);

int ipworksssl_sslserver_getdefaulteol(void* lpObj, char** lpDefaultEOL, int* lenDefaultEOL);
int ipworksssl_sslserver_setdefaulteol(void* lpObj, const char* lpDefaultEOL, int lenDefaultEOL);

QByteArray GetDefaultEOL();
int SetDefaultEOL(QByteArray qbaDefaultEOL);

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

Data Type

Binary String

DefaultIdleTimeout Property (SSLServer Class)

This property includes the default idle timeout for inactive clients.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);

Unicode (Windows)
INT GetDefaultIdleTimeout();
INT SetDefaultIdleTimeout(INT iDefaultIdleTimeout);

int ipworksssl_sslserver_getdefaultidletimeout(void* lpObj);
int ipworksssl_sslserver_setdefaultidletimeout(void* lpObj, int iDefaultIdleTimeout);

int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

Data Type

Integer

DefaultMaxLineLength Property (SSLServer Class)

The property includes the default maximum line length value for inbound connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultMaxLineLength();
int SetDefaultMaxLineLength(int iDefaultMaxLineLength);

Unicode (Windows)
INT GetDefaultMaxLineLength();
INT SetDefaultMaxLineLength(INT iDefaultMaxLineLength);

int ipworksssl_sslserver_getdefaultmaxlinelength(void* lpObj);
int ipworksssl_sslserver_setdefaultmaxlinelength(void* lpObj, int iDefaultMaxLineLength);

int GetDefaultMaxLineLength();
int SetDefaultMaxLineLength(int iDefaultMaxLineLength);

Default Value

2048

Remarks

This property controls the default size of an internal buffer that holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes.

Data Type

Integer

DefaultSingleLineMode Property (SSLServer Class)

This property tells the class whether or not to treat new connections as line oriented.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(int bDefaultSingleLineMode);

Unicode (Windows)
BOOL GetDefaultSingleLineMode();
INT SetDefaultSingleLineMode(BOOL bDefaultSingleLineMode);

int ipworksssl_sslserver_getdefaultsinglelinemode(void* lpObj);
int ipworksssl_sslserver_setdefaultsinglelinemode(void* lpObj, int bDefaultSingleLineMode);

bool GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(bool bDefaultSingleLineMode);

Default Value

FALSE

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

Data Type

Boolean

DefaultTimeout Property (SSLServer Class)

This property includes an initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_getdefaulttimeout(void* lpObj);
int ipworksssl_sslserver_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

KeepAlive Property (SSLServer Class)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetKeepAlive();
int SetKeepAlive(int bKeepAlive);

Unicode (Windows)
BOOL GetKeepAlive();
INT SetKeepAlive(BOOL bKeepAlive);

int ipworksssl_sslserver_getkeepalive(void* lpObj);
int ipworksssl_sslserver_setkeepalive(void* lpObj, int bKeepAlive);

bool GetKeepAlive();
int SetKeepAlive(bool bKeepAlive);

Default Value

FALSE

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property 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.

Data Type

Boolean

Linger Property (SSLServer Class)

When set to True, connections are terminated gracefully.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinger();
int SetLinger(int bLinger);

Unicode (Windows)
BOOL GetLinger();
INT SetLinger(BOOL bLinger);

int ipworksssl_sslserver_getlinger(void* lpObj);
int ipworksssl_sslserver_setlinger(void* lpObj, int bLinger);

bool GetLinger();
int SetLinger(bool bLinger);

Default Value

TRUE

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action.

This property 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.

Data Type

Boolean

Listening Property (SSLServer Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();

int ipworksssl_sslserver_getlistening(void* lpObj);

bool GetListening();

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksssl_sslserver_getlocalhost(void* lpObj);
int ipworksssl_sslserver_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_getlocalport(void* lpObj);
int ipworksssl_sslserver_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 (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_getsslauthenticateclients(void* lpObj);
int ipworksssl_sslserver_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

SSLCert Property (SSLServer Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksSSLCertificate* GetSSLCert();
int SetSSLCert(IPWorksSSLCertificate* val);

char* ipworksssl_sslserver_getsslcerteffectivedate(void* lpObj);

char* ipworksssl_sslserver_getsslcertexpirationdate(void* lpObj);

char* ipworksssl_sslserver_getsslcertextendedkeyusage(void* lpObj);

char* ipworksssl_sslserver_getsslcertfingerprint(void* lpObj);

char* ipworksssl_sslserver_getsslcertfingerprintsha1(void* lpObj);

char* ipworksssl_sslserver_getsslcertfingerprintsha256(void* lpObj);

char* ipworksssl_sslserver_getsslcertissuer(void* lpObj);

char* ipworksssl_sslserver_getsslcertprivatekey(void* lpObj);

int ipworksssl_sslserver_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksssl_sslserver_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksssl_sslserver_getsslcertpublickey(void* lpObj);

char* ipworksssl_sslserver_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksssl_sslserver_getsslcertpublickeylength(void* lpObj);

char* ipworksssl_sslserver_getsslcertserialnumber(void* lpObj);

char* ipworksssl_sslserver_getsslcertsignaturealgorithm(void* lpObj);

int ipworksssl_sslserver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_sslserver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksssl_sslserver_getsslcertstorepassword(void* lpObj);
int ipworksssl_sslserver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksssl_sslserver_getsslcertstoretype(void* lpObj);
int ipworksssl_sslserver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksssl_sslserver_getsslcertsubjectaltnames(void* lpObj);

char* ipworksssl_sslserver_getsslcertthumbprintmd5(void* lpObj);

char* ipworksssl_sslserver_getsslcertthumbprintsha1(void* lpObj);

char* ipworksssl_sslserver_getsslcertthumbprintsha256(void* lpObj);

char* ipworksssl_sslserver_getsslcertusage(void* lpObj);

int ipworksssl_sslserver_getsslcertusageflags(void* lpObj);

char* ipworksssl_sslserver_getsslcertversion(void* lpObj);

char* ipworksssl_sslserver_getsslcertsubject(void* lpObj);
int ipworksssl_sslserver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksssl_sslserver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_sslserver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksSSLCertificate

SSLProvider Property (SSLServer Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksssl_sslserver_getsslprovider(void* lpObj);
int ipworksssl_sslserver_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

ChangeRecordLength Method (SSLServer Class)

This method changes the length of received data records.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeRecordLength(int iConnectionId, int iRecordLength);

Unicode (Windows)
INT ChangeRecordLength(INT iConnectionId, INT iRecordLength);

int ipworksssl_sslserver_changerecordlength(void* lpObj, int iConnectionId, int iRecordLength);

int ChangeRecordLength(int iConnectionId, int iRecordLength);

Remarks

This method defines the length of data records to be received (in bytes) for the specified ConnectionId.

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data are received and only then will fire the DataIn event with data of the specified length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the DataIn event.

A value of 0 (default) means this functionality is not used.

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

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksssl_sslserver_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 (SSLServer Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksssl_sslserver_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 (SSLServer Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssl_sslserver_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 (SSLServer Class)

This method interrupts a synchronous send to the remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT Interrupt(INT iConnectionId);

int ipworksssl_sslserver_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.)

PauseData Method (SSLServer Class)

This method pauses data reception.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT PauseData(INT iConnectionId);

int ipworksssl_sslserver_pausedata(void* lpObj, int iConnectionId);

int PauseData(int iConnectionId);

Remarks

This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call ProcessData to reenable data reception.

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

ProcessData Method (SSLServer Class)

This method reenables data reception after a call to PauseData .

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ProcessData(INT iConnectionId);

int ipworksssl_sslserver_processdata(void* lpObj, int iConnectionId);

int ProcessData(int iConnectionId);

Remarks

This method reenables data reception for the connection identified by ConnectionId after a previous call to PauseData. When PauseData is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

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

Reset Method (SSLServer Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssl_sslserver_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

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

This method sends binary data to the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Send(int iConnectionId, const char* lpText, int lenText);

Unicode (Windows)
INT Send(INT iConnectionId, LPCSTR lpText, INT lenText);

int ipworksssl_sslserver_send(void* lpObj, int iConnectionId, const char* lpText, int lenText);

int Send(int iConnectionId, QByteArray qbaText);

Remarks

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

When Timeout 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.)

SendBytes Method (SSLServer Class)

This method sends binary data to the specified client.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_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 Timeout 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 (SSLServer Class)

This method sends the file to the remote host.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_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.)

SendLine Method (SSLServer Class)

This method sends a string followed by a new line.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .

Please refer to the GetLine method and SingleLineMode property for more information.

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

This method sends text to the specified client.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslserver_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 Timeout 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.)

Shutdown Method (SSLServer Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksssl_sslserver_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 (SSLServer Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksssl_sslserver_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 (SSLServer Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksssl_sslserver_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 (SSLServer Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_CONNECTED 1

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

class SSLServerConnectedEventParams {
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 Connected(SSLServerConnectedEventParams *e);

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

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_CONNECTIONREQUEST 2

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

class SSLServerConnectionRequestEventParams {
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(SSLServerConnectionRequestEventParams *e);

// Or, subclass SSLServer and override this emitter function.
virtual int FireConnectionRequest(SSLServerConnectionRequestEventParams *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 (SSLServer Class)

This event is fired when data come in.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ConnectionId;
  const char *Text;
  int lenText;
  int EOL;
  int reserved;
} SSLServerDataInEventParams;


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

typedef struct {
  INT ConnectionId;
  LPCSTR Text;
  INT lenText;
  BOOL EOL;
  INT reserved;
} SSLServerDataInEventParams;

#define EID_SSLSERVER_DATAIN 3

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

class SSLServerDataInEventParams {
public:
  int ConnectionId();

  const QByteArray &Text();

  bool EOL();

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

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

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

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or MaxLineLength with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (SSLServer Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_DISCONNECTED 4

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

class SSLServerDisconnectedEventParams {
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(SSLServerDisconnectedEventParams *e);

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

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (SSLServer Class)

This event fires information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_ERROR 5

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

class SSLServerErrorEventParams {
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(SSLServerErrorEventParams *e);

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

Remarks

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

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.

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_READYTOSEND 6

virtual INT IPWORKSSSL_CALL FireReadyToSend(INT &iConnectionId);

class SSLServerReadyToSendEventParams {
public:
  int ConnectionId();

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

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

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

Remarks

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

SSLClientAuthentication Event (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_SSLCLIENTAUTHENTICATION 7

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

class SSLServerSSLClientAuthenticationEventParams {
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(SSLServerSSLClientAuthenticationEventParams *e);

// Or, subclass SSLServer and override this emitter function.
virtual int FireSSLClientAuthentication(SSLServerSSLClientAuthenticationEventParams *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 (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_SSLCONNECTIONREQUEST 8

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

class SSLServerSSLConnectionRequestEventParams {
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(SSLServerSSLConnectionRequestEventParams *e);

// Or, subclass SSLServer and override this emitter function.
virtual int FireSSLConnectionRequest(SSLServerSSLConnectionRequestEventParams *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 field can take one of the following values:

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

Designations of certificate stores are platform dependent.

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

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

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

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

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

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

SSLStatus Event (SSLServer Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLSERVER_SSLSTATUS 9

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

class SSLServerSSLStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

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

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

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

Remarks

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

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksSSLCertificate (declared in ipworksssl.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Connection Type

This is a currently connected client.

Syntax

IPWorksSSLConnection (declared in ipworksssl.h)

Remarks

This type describes the connection of a client that is currently connected to the class. You may use the different fields of this type to manage the connection.

Fields

Constructors

Connection()

IPWorksSSLList Type

Syntax

IPWorksSSLList<T> (declared in ipworksssl.h)

Remarks

IPWorksSSLList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SSLServer class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SSLServer Class)

TCPServer Config Settings

SSL Config Settings

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

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

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

Base Config Settings

Trappable Errors (SSLServer 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.

SSLServer Errors

SSL Errors

TCP/IP Errors