SSLClient Class

Properties   Methods   Events   Config Settings   Errors  

The SSLClient Class is a generic Transmission Control Protocol (TCP) stream client based on an asynchronous, event-driven architecture.

Syntax

SSLClient

Remarks

The SSLClient 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.

Our main goal in designing SSLClient was ease of use. The class has a minimum number of properties and five events: Connected, DataIn, Disconnected, ReadyToSend, and Error. The events are relatively self-explanatory.

The connection is attempted by calling the Connect method or setting the Connected property to True, and then waiting for the Connected event. The destination is defined by setting RemoteHost and RemotePort. Data are sent by calling the Send method with Text as a parameter.

To disconnect, you just call the Disconnect method or set the Connected property to False. The Linger property controls how the connection is terminated.

The operation of the class is almost completely asynchronous. All of the calls, except the ones that deal with domain name resolution, operate through asynchronous messages (no blocking calls). The gain in performance is considerable compared with using blocking calls.

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.

AcceptData Property (SSLClient Class)

This property indicates whether data reception is currently enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();

Unicode (Windows)
BOOL GetAcceptData();

int ipworksssl_sslclient_getacceptdata(void* lpObj);

bool GetAcceptData();

Default Value

TRUE

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the DataIn event will not fire. Use the PauseData and ProcessData methods to pause and resume data reception.

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

Data Type

Boolean

BytesSent Property (SSLClient Class)

This property includes the number of bytes actually sent after a call to the SendBytes method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();

int ipworksssl_sslclient_getbytessent(void* lpObj);

int GetBytesSent();

Default Value

0

Remarks

This property indicates how many bytes were sent after the last call to SendBytes. Please check the SendBytes method for more information.

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

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

Data Type

Integer

Connected Property (SSLClient Class)

This property indicates whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksssl_sslclient_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property indicates whether the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

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

Data Type

Boolean

EOL Property (SSLClient Class)

This property is used to break the incoming data stream into chunks separated by EOL .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEOL(char* &lpEOL, int &lenEOL);
int SetEOL(const char* lpEOL, int lenEOL);

Unicode (Windows)
INT GetEOL(LPSTR &lpEOL, INT &lenEOL);
INT SetEOL(LPCSTR lpEOL, INT lenEOL);

int ipworksssl_sslclient_geteol(void* lpObj, char** lpEOL, int* lenEOL);
int ipworksssl_sslclient_seteol(void* lpObj, const char* lpEOL, int lenEOL);

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

Default Value

""

Remarks

This property is used to define boundaries in the input stream using the value of the property.

This property is especially useful with ASCII files. Setting it to CRLF ("\r\n") enables the incoming ASCII text stream to split into defined lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") bytes are discarded.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

Data Type

Binary String

Firewall Property (SSLClient Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksSSLFirewall* GetFirewall();
int SetFirewall(IPWorksSSLFirewall* val);

int ipworksssl_sslclient_getfirewallautodetect(void* lpObj);
int ipworksssl_sslclient_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksssl_sslclient_getfirewalltype(void* lpObj);
int ipworksssl_sslclient_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksssl_sslclient_getfirewallhost(void* lpObj);
int ipworksssl_sslclient_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksssl_sslclient_getfirewallpassword(void* lpObj);
int ipworksssl_sslclient_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksssl_sslclient_getfirewallport(void* lpObj);
int ipworksssl_sslclient_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksssl_sslclient_getfirewalluser(void* lpObj);
int ipworksssl_sslclient_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksSSLFirewall

KeepAlive Property (SSLClient 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_sslclient_getkeepalive(void* lpObj);
int ipworksssl_sslclient_setkeepalive(void* lpObj, int bKeepAlive);

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

Default Value

FALSE

Remarks

The KeepAlive enables the SO_KEEPALIVE option on the socket. 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.

Data Type

Boolean

Linger Property (SSLClient Class)

When set to True, this property ensures that 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_sslclient_getlinger(void* lpObj);
int ipworksssl_sslclient_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 the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

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

Data Type

Boolean

LocalHost Property (SSLClient 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_sslclient_getlocalhost(void* lpObj);
int ipworksssl_sslclient_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 (SSLClient Class)

The TCP port in the local host where the class binds.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_sslclient_getlocalport(void* lpObj);
int ipworksssl_sslclient_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port on the client side.

Data Type

Integer

ReadyToSend Property (SSLClient Class)

This property indicates whether the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReadyToSend();

Unicode (Windows)
BOOL GetReadyToSend();

int ipworksssl_sslclient_getreadytosend(void* lpObj);

bool GetReadyToSend();

Default Value

FALSE

Remarks

This property indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data. This is True after connecting to the remote host and will become False after a failed SendBytes.

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

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

Data Type

Boolean

RecordLength Property (SSLClient Class)

This property indicates the length of received data records.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecordLength();

Unicode (Windows)
INT GetRecordLength();

int ipworksssl_sslclient_getrecordlength(void* lpObj);

int GetRecordLength();

Default Value

0

Remarks

This property holds the current record length set by ChangeRecordLength. When this value is a positive number, the class will accumulate data until RecordLength is reached and only then will fire the DataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time by calling ChangeRecordLength, including within the DataIn event.

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

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

Data Type

Integer

RemoteHost Property (SSLClient Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworksssl_sslclient_getremotehost(void* lpObj);
int ipworksssl_sslclient_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

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.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Data Type

String

RemotePort Property (SSLClient Class)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworksssl_sslclient_getremoteport(void* lpObj);
int ipworksssl_sslclient_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SingleLineMode Property (SSLClient Class)

This property includes a special mode for line-oriented protocols.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSingleLineMode();
int SetSingleLineMode(int bSingleLineMode);

Unicode (Windows)
BOOL GetSingleLineMode();
INT SetSingleLineMode(BOOL bSingleLineMode);

int ipworksssl_sslclient_getsinglelinemode(void* lpObj);
int ipworksssl_sslclient_setsinglelinemode(void* lpObj, int bSingleLineMode);

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

Default Value

FALSE

Remarks

When this property is set to True, the class treats the incoming data stream as lines separated by carriage return line feed (CRLF), CR, or LF. The EOL property is ignored.

When this property is set to True, AcceptData automatically will be set to False. Please refer to the GetLine method for more information.

This property is not available at design time.

Data Type

Boolean

SSLAcceptServerCert Property (SSLClient Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksSSLCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksSSLCertificate* val);

char* ipworksssl_sslclient_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertissuer(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertprivatekey(void* lpObj);

int ipworksssl_sslclient_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertpublickey(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksssl_sslclient_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksssl_sslclient_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksssl_sslclient_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksssl_sslclient_getsslacceptservercertstorepassword(void* lpObj);
int ipworksssl_sslclient_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksssl_sslclient_getsslacceptservercertstoretype(void* lpObj);
int ipworksssl_sslclient_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksssl_sslclient_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertusage(void* lpObj);

int ipworksssl_sslclient_getsslacceptservercertusageflags(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertversion(void* lpObj);

char* ipworksssl_sslclient_getsslacceptservercertsubject(void* lpObj);
int ipworksssl_sslclient_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksssl_sslclient_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksssl_sslclient_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksSSLCertificate

SSLCert Property (SSLClient Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksssl_sslclient_getsslcerteffectivedate(void* lpObj);

char* ipworksssl_sslclient_getsslcertexpirationdate(void* lpObj);

char* ipworksssl_sslclient_getsslcertextendedkeyusage(void* lpObj);

char* ipworksssl_sslclient_getsslcertfingerprint(void* lpObj);

char* ipworksssl_sslclient_getsslcertfingerprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslcertfingerprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslcertissuer(void* lpObj);

char* ipworksssl_sslclient_getsslcertprivatekey(void* lpObj);

int ipworksssl_sslclient_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksssl_sslclient_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksssl_sslclient_getsslcertpublickey(void* lpObj);

char* ipworksssl_sslclient_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksssl_sslclient_getsslcertpublickeylength(void* lpObj);

char* ipworksssl_sslclient_getsslcertserialnumber(void* lpObj);

char* ipworksssl_sslclient_getsslcertsignaturealgorithm(void* lpObj);

int ipworksssl_sslclient_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_sslclient_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksssl_sslclient_getsslcertstorepassword(void* lpObj);
int ipworksssl_sslclient_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksssl_sslclient_getsslcertstoretype(void* lpObj);
int ipworksssl_sslclient_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksssl_sslclient_getsslcertsubjectaltnames(void* lpObj);

char* ipworksssl_sslclient_getsslcertthumbprintmd5(void* lpObj);

char* ipworksssl_sslclient_getsslcertthumbprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslcertthumbprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslcertusage(void* lpObj);

int ipworksssl_sslclient_getsslcertusageflags(void* lpObj);

char* ipworksssl_sslclient_getsslcertversion(void* lpObj);

char* ipworksssl_sslclient_getsslcertsubject(void* lpObj);
int ipworksssl_sslclient_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksssl_sslclient_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_sslclient_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 (SSLClient 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_sslclient_getsslprovider(void* lpObj);
int ipworksssl_sslclient_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

SSLServerCert Property (SSLClient Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksSSLCertificate* GetSSLServerCert();

char* ipworksssl_sslclient_getsslservercerteffectivedate(void* lpObj);

char* ipworksssl_sslclient_getsslservercertexpirationdate(void* lpObj);

char* ipworksssl_sslclient_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksssl_sslclient_getsslservercertfingerprint(void* lpObj);

char* ipworksssl_sslclient_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslservercertissuer(void* lpObj);

char* ipworksssl_sslclient_getsslservercertprivatekey(void* lpObj);

int ipworksssl_sslclient_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksssl_sslclient_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksssl_sslclient_getsslservercertpublickey(void* lpObj);

char* ipworksssl_sslclient_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksssl_sslclient_getsslservercertpublickeylength(void* lpObj);

char* ipworksssl_sslclient_getsslservercertserialnumber(void* lpObj);

char* ipworksssl_sslclient_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksssl_sslclient_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksssl_sslclient_getsslservercertstorepassword(void* lpObj);

int ipworksssl_sslclient_getsslservercertstoretype(void* lpObj);

char* ipworksssl_sslclient_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksssl_sslclient_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksssl_sslclient_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksssl_sslclient_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksssl_sslclient_getsslservercertusage(void* lpObj);

int ipworksssl_sslclient_getsslservercertusageflags(void* lpObj);

char* ipworksssl_sslclient_getsslservercertversion(void* lpObj);

char* ipworksssl_sslclient_getsslservercertsubject(void* lpObj);

int ipworksssl_sslclient_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksSSLCertificate

Timeout Property (SSLClient Class)

This property includes the timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksssl_sslclient_gettimeout(void* lpObj);
int ipworksssl_sslclient_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

If Timeout 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 Timeout 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.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

ChangeRecordLength Method (SSLClient Class)

This method changes the length of received data records.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ChangeRecordLength(INT iRecordLength);

int ipworksssl_sslclient_changerecordlength(void* lpObj, int iRecordLength);

int ChangeRecordLength(int iRecordLength);

Remarks

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

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data are received and only then will it fire the DataIn event with data of 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 (SSLClient 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_sslclient_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.

Connect Method (SSLClient Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksssl_sslclient_connect(void* lpObj);

int Connect();

Remarks

This method connects to the remote host specified by RemoteHost and RemotePort. For instance: component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect();

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

ConnectTo Method (SSLClient Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ConnectTo(const char* lpszHost, int iPort);

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszHost, INT iPort);

int ipworksssl_sslclient_connectto(void* lpObj, const char* lpszHost, int iPort);

int ConnectTo(const QString& qsHost, int iPort);

Remarks

This method connects to the remote host specified by the Host and Port parameters. For instance: component.ConnectTo("MyHostNameOrIP", 777)

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

Disconnect Method (SSLClient Class)

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksssl_sslclient_disconnect(void* lpObj);

int Disconnect();

Remarks

This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.

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 (SSLClient 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_sslclient_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.)

GetLine Method (SSLClient Class)

This method gets a line of text from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLine();

Unicode (Windows)
LPWSTR GetLine();

char* ipworksssl_sslclient_getline(void* lpObj);

QString GetLine();

Remarks

This method gets a line of text from the server. This method is an alternative method of receiving data for line-oriented protocols. The class will block if necessary and then will return the received line. AcceptData will be set automatically to True when the method is called, and then will be set to False after a line is received.

Please refer to the SingleLineMode property for more information.

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.

Interrupt Method (SSLClient Class)

This method interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksssl_sslclient_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

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

This method pauses data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PauseData();

Unicode (Windows)
INT PauseData();

int ipworksssl_sslclient_pausedata(void* lpObj);

int PauseData();

Remarks

This method pauses data reception when called. While data reception is paused, the DataIn event will not fire. 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 (SSLClient Class)

This method reenables data reception after a call to PauseData .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ProcessData();

Unicode (Windows)
INT ProcessData();

int ipworksssl_sslclient_processdata(void* lpObj);

int ProcessData();

Remarks

This method reenables data reception after a previous call to PauseData. When PauseData is called, the DataIn event will not fire. 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 (SSLClient Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssl_sslclient_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 (SSLClient Class)

This method sends binary data to the remote host.

Syntax

• C++
• C
• Qt

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

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

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

int Send(QByteArray qbaText);

Remarks

This method sends the specified binary data to the remote host. 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 (SSLClient Class)

This method sends binary data to the remote host.

Syntax

• C++
• C
• Qt

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

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

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

int SendBytes(QByteArray qbaData);

Remarks

This method sends the specified binary data to the remote host. 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 (SSLClient Class)

This method sends a file to the remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendFile(LPCWSTR lpszFileName);

int ipworksssl_sslclient_sendfile(void* lpObj, const char* lpszFileName);

int SendFile(const QString& qsFileName);

Remarks

This method sends the specified file to the remote host.

This method requires Timeout be set to a positive value. This allows the class to ensure that the file is transferred completely without a WOULDBLOCK error. See Timeout for details.

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

This method sends a string followed by a newline.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendLine(LPCWSTR lpszText);

int ipworksssl_sslclient_sendline(void* lpObj, const char* lpszText);

int SendLine(const QString& qsText);

Remarks

This method sends a string followed by a newline. 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 (SSLClient Class)

This method sends text to the remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendText(LPCWSTR lpszText);

int ipworksssl_sslclient_sendtext(void* lpObj, const char* lpszText);

int SendText(const QString& qsText);

Remarks

This method sends the specified text to the remote host. 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.)

StartSSL Method (SSLClient Class)

This method starts Secure Sockets Layer (SSL) negotiation on a plaintext connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartSSL();

Unicode (Windows)
INT StartSSL();

int ipworksssl_sslclient_startssl(void* lpObj);

int StartSSL();

Remarks

This method is used to start SSL negotiation on a plaintext connection. Please refer to the SSLStartMode property for more information.

Note: The Connected event will fire again after SSL negotiation is complete.

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

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSLClientConnectedEventParams;

#define EID_SSLCLIENT_CONNECTED 1

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

class SSLClientConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SSLClient and override this emitter function.
virtual int FireConnected(SSLClientConnectedEventParams *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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SSLClient Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SSLClientConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SSLClientConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SSLClientConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSLClientConnectionStatusEventParams;

#define EID_SSLCLIENT_CONNECTIONSTATUS 2

virtual INT IPWORKSSSL_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class SSLClientConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SSLClient and override this emitter function.
virtual int FireConnectionStatus(SSLClientConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DataIn Event (SSLClient Class)

This event is fired when data (complete lines) come in.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SSLCLIENT_DATAIN 3

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

class SSLClientDataInEventParams {
public:
  const QByteArray &Text();

  bool EOL();

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

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

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

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection. 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 a data portion of length larger than MaxLineLength with no EOL strings in it, then EOL is False. Note: 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 (SSLClient Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SSLClientDisconnectedEventParams;

#define EID_SSLCLIENT_DISCONNECTED 4

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

class SSLClientDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass SSLClient and override this emitter function.
virtual int FireDisconnected(SSLClientDisconnectedEventParams *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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (SSLClient Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SSLClientErrorEventParams;

#define EID_SSLCLIENT_ERROR 5

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

class SSLClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

ReadyToSend Event (SSLClient Class)

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int reserved;
} SSLClientReadyToSendEventParams;


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

typedef struct {
  INT reserved;
} SSLClientReadyToSendEventParams;

#define EID_SSLCLIENT_READYTOSEND 6

virtual INT IPWORKSSSL_CALL FireReadyToSend();

class SSLClientReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

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

Remarks

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

SSLServerAuthentication Event (SSLClient Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SSLClientSSLServerAuthenticationEventParams *e);

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


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SSLClientSSLServerAuthenticationEventParams *e);

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

#define EID_SSLCLIENT_SSLSERVERAUTHENTICATION 7

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

class SSLClientSSLServerAuthenticationEventParams {
public:
  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 SSLServerAuthentication(SSLClientSSLServerAuthenticationEventParams *e);

// Or, subclass SSLClient and override this emitter function.
virtual int FireSSLServerAuthentication(SSLClientSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or 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). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SSLClient Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Message;
  int reserved;
} SSLClientSSLStatusEventParams;


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

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SSLClientSSLStatusEventParams;

#define EID_SSLCLIENT_SSLSTATUS 8

virtual INT IPWORKSSSL_CALL FireSSLStatus(LPSTR &lpszMessage);

class SSLClientSSLStatusEventParams {
public:
  const QString &Message();

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

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

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

Remarks

The event is fired for informational and logging purposes only. This event tracks 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)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksSSLFirewall (declared in ipworksssl.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

Config Settings (SSLClient Class)

TCPClient 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-----

Socket Config Settings

Base Config Settings

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

SSLClient Errors

SSL Errors

TCP/IP Errors