DTLSClient Class

Properties   Methods   Events   Config Settings   Errors  

The DTLSClient class provides client-side functionality for secure UDP communication utilizing the Datagram Transport Layer Security (DTLS) protocol.

Syntax

DTLSClient

Remarks

The DTLSClient class functions as a client that facilitates in connecting to DTLS servers and offers a convenient means of transmitting and receiving datagrams over the established, secure connection.

Connecting to a Server

First, the RemoteHost and RemotePort must be set to the address and port of the target DTLS server. The Timeout property can be used to specify a timeout when connecting to the server. To initiate the connection, call Connect.

After doing so, the handshake process will begin. Relevant handshake details will be reported by the SSLStatus event. Initially, the server will present its certificate to the client. The certificate can be evaluated within the SSLServerAuthentication event. By default, the class will provide a recommendation of whether to accept or reject the certificate, and reasoning behind the recommendation. Regardless, the certificate can be manually accepted (or rejected) within this event.

In some cases, the server requires the client to present a certificate as well. In this case, a valid certificate will need to be specified via the SSLCert property.

Once the connection is complete (or fails), the Connected event will fire. Note that this event will fire if a connection succeeds or fails. If successful, the event will fire with a StatusCode of 0. If this value is non-zero, it indicates the connection was unsuccessful. The Description parameter will contain relevant details. Upon successful connection, the Connected property will be set to True. This process may look like the following:

dtlsclient.OnConnected += (o, e) => { if (e.StatusCode == 0) { Console.WriteLine("Connection successful!"); } else { Console.WriteLine("Connection failed."); Console.WriteLine("Error code: " + e.StatusCode); Console.WriteLine("Error description: " + e.Description); } }; dtlsclient.OnSSLServerAuthentication += (o, e) => { if (e.Accept) return; Console.Write("Server provided the following certificate:\nIssuer: " + e.CertIssuer + "\nSubject: " + e.CertSubject + "\n"); Console.Write("The following problems have been determined for this certificate: " + e.Status + "\n"); Console.Write("Would you like to accept anyways? [y/n] "); if (Console.Read() == 'y') e.Accept = true; }; dtlsclient.RemoteHost = "remote_ip"; dtlsclient.RemotePort = 1234; dtlsclient.Timeout = 30; // if client authentication is applicable dtlsclient.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject"); dtlsclient.Connect();

Sending and Receiving Data

Once a successful connection is established, the class can send data to the server via SendText or SendBytes.

The class will also be able to receive data from the server via the DataIn event. Note that this event is non-reentrant, and it is recommended to offload time-consuming operations to ensure the best performance.

If required, the PauseData method can be called, disabling the reception of incoming data from the server. Data reception can later be enabled via the ProcessData method. Note that if this reception is disabled, the server may continue sending data, which will remain unprocessed by the class. In this case, the underlying socket buffer may be filled. This can result in possible data loss originating from the server. Please use these methods with caution.

The complete process may look like the following:

dtlsclient.OnSSLServerAuthentication += (o, e) => { e.Accept = true; }; dtlsclient.OnDataIn += (o, e) => { Console.WriteLine("Packet received from server."); Console.WriteLine("Datagram: " + e.Datagram); } dtlsclient.RemoteHost = "remote_ip"; dtlsclient.RemotePort = 1234; dtlsclient.Connect(); dtlsclient.SendText("Hello World!"); while (true) { dtlsclient.DoEvents(); }

Disconnecting from a Server

Once the connection to the server is broken, the Disconnected event will fire. The disconnection can be performed by calling Disconnect, or performed by the server.

In the case a connection ends and an error is encountered, the StatusCode and Description parameters will contain relevant details regarding the error. For example:

dtlsclient.OnDisconnected += (o, e) => { if (e.StatusCode == 0) { Console.WriteLine("Connection ended."); } else { Console.WriteLine("Connection ended."); Console.WriteLine("Error code: " + e.StatusCode); Console.WriteLine("Error description: " + e.Description); } }; dtlsclient.RemoteHost = "remote_ip"; dtlsclient.RemotePort = 1234; dtlsclient.Connect(); ... ... ... dtlsclient.Disconnect();

Additional Information

To support KeepAlive functionality, it is important to note that DoEvents must be called regularly in both console and form-based applications. This is to ensure the class sends keep-alive (or Heartbeat) packets to the server in a timely manner.

In form-based applications, this does not apply if KeepAlive is False.

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

This property indicates whether data reception is currently enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();

Unicode (Windows)
BOOL GetAcceptData();

int ipworksdtls_dtlsclient_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

Connected Property (DTLSClient Class)

This property indicates whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksdtls_dtlsclient_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

KeepAlive Property (DTLSClient Class)

When True, keep-alive functionality is enabled via the DTLS Heartbeat Extension.

Syntax

• C++
• C
• Qt

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

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

int ipworksdtls_dtlsclient_getkeepalive(void* lpObj);
int ipworksdtls_dtlsclient_setkeepalive(void* lpObj, int bKeepAlive);

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

Default Value

FALSE

Remarks

This property enables keep-alive functionality for the established connection via the DTLS Heartbeat Extension (RFC 6520). Enabling this option can prevent a long connection from timing out in case of inactivity.

Note: For this functionality to work as intended, DoEvents must be called frequently in both console and form-based applications (e.g., using a loop or timer).

Additionally, DTLS server implementations are not required to support Heartbeats.

Data Type

Boolean

LocalHost Property (DTLSClient 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* ipworksdtls_dtlsclient_getlocalhost(void* lpObj);
int ipworksdtls_dtlsclient_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 (DTLSClient Class)

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Syntax

• C++
• C
• Qt

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

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

int ipworksdtls_dtlsclient_getlocalport(void* lpObj);
int ipworksdtls_dtlsclient_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). This instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the Transmission Control Protocol (TCP)/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

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

Data Type

Integer

RemoteHost Property (DTLSClient 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* ipworksdtls_dtlsclient_getremotehost(void* lpObj);
int ipworksdtls_dtlsclient_setremotehost(void* lpObj, const char* lpszRemoteHost);

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

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or domain name of the remote host.

If RemoteHost is set to 255.255.255.255, the class broadcasts data on the local subnet.

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

If UseConnection is set to True, the RemoteHost must be set before the class is activated (Active is set to True).

Data Type

String

RemotePort Property (DTLSClient Class)

This property specifies the User Datagram Protocol (UDP) 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 ipworksdtls_dtlsclient_getremoteport(void* lpObj);
int ipworksdtls_dtlsclient_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

0

Remarks

The RemotePort is the UDP port on the RemoteHost to send UDP datagrams to.

A valid port number (a value between 1 and 65535) is required.

If UseConnection is set to True, the RemotePort must be set before the class is activated (Active is set to True).

Data Type

Integer

SSLAcceptServerCert Property (DTLSClient Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksdtls_dtlsclient_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertissuer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertprivatekey(void* lpObj);

int ipworksdtls_dtlsclient_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertpublickey(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksdtls_dtlsclient_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksdtls_dtlsclient_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksdtls_dtlsclient_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksdtls_dtlsclient_getsslacceptservercertstorepassword(void* lpObj);
int ipworksdtls_dtlsclient_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksdtls_dtlsclient_getsslacceptservercertstoretype(void* lpObj);
int ipworksdtls_dtlsclient_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksdtls_dtlsclient_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertusage(void* lpObj);

int ipworksdtls_dtlsclient_getsslacceptservercertusageflags(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertversion(void* lpObj);

char* ipworksdtls_dtlsclient_getsslacceptservercertsubject(void* lpObj);
int ipworksdtls_dtlsclient_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksdtls_dtlsclient_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksdtls_dtlsclient_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

IPWorksDTLSCertificate

SSLCert Property (DTLSClient Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksdtls_dtlsclient_getsslcerteffectivedate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertexpirationdate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertextendedkeyusage(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertfingerprint(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertfingerprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertfingerprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertissuer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertprivatekey(void* lpObj);

int ipworksdtls_dtlsclient_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertpublickey(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksdtls_dtlsclient_getsslcertpublickeylength(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertserialnumber(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertsignaturealgorithm(void* lpObj);

int ipworksdtls_dtlsclient_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksdtls_dtlsclient_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksdtls_dtlsclient_getsslcertstorepassword(void* lpObj);
int ipworksdtls_dtlsclient_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksdtls_dtlsclient_getsslcertstoretype(void* lpObj);
int ipworksdtls_dtlsclient_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksdtls_dtlsclient_getsslcertsubjectaltnames(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertthumbprintmd5(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertthumbprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertthumbprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertusage(void* lpObj);

int ipworksdtls_dtlsclient_getsslcertusageflags(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertversion(void* lpObj);

char* ipworksdtls_dtlsclient_getsslcertsubject(void* lpObj);
int ipworksdtls_dtlsclient_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksdtls_dtlsclient_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksdtls_dtlsclient_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

IPWorksDTLSCertificate

SSLServerCert Property (DTLSClient Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksDTLSCertificate* GetSSLServerCert();

char* ipworksdtls_dtlsclient_getsslservercerteffectivedate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertexpirationdate(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertfingerprint(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertissuer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertprivatekey(void* lpObj);

int ipworksdtls_dtlsclient_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertpublickey(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksdtls_dtlsclient_getsslservercertpublickeylength(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertserialnumber(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworksdtls_dtlsclient_getsslservercertstorepassword(void* lpObj);

int ipworksdtls_dtlsclient_getsslservercertstoretype(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertusage(void* lpObj);

int ipworksdtls_dtlsclient_getsslservercertusageflags(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertversion(void* lpObj);

char* ipworksdtls_dtlsclient_getsslservercertsubject(void* lpObj);

int ipworksdtls_dtlsclient_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

IPWorksDTLSCertificate

Timeout Property (DTLSClient Class)

This property specifies a timeout when connecting to a server.

Syntax

• C++
• C
• Qt

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

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

int ipworksdtls_dtlsclient_gettimeout(void* lpObj);
int ipworksdtls_dtlsclient_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

This property specifies a timeout when connecting to a server. When calling Connect, if the connection is not established within Timeout seconds, an error is thrown.

Data Type

Integer

Config Method (DTLSClient 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* ipworksdtls_dtlsclient_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 (DTLSClient Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

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

Disconnect Method (DTLSClient Class)

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksdtls_dtlsclient_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 (DTLSClient Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

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

PauseData Method (DTLSClient Class)

This method pauses data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PauseData();

Unicode (Windows)
INT PauseData();

int ipworksdtls_dtlsclient_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 (DTLSClient 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 ipworksdtls_dtlsclient_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 (DTLSClient Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendBytes Method (DTLSClient 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 ipworksdtls_dtlsclient_sendbytes(void* lpObj, const char* lpData, int lenData);

int SendBytes(QByteArray qbaData);

Remarks

This method sends the specified binary data to the remote host. For example:

byte[] dataToSend = new byte[] { 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33 }; dtlsclient.SendBytes(dataToSend);

To send text, use the SendText method 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.)

SendText Method (DTLSClient 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 ipworksdtls_dtlsclient_sendtext(void* lpObj, const char* lpszText);

int SendText(const QString& qsText);

Remarks

This method sends the specified text to the remote host. For example:

dtlsclient.onSSLServerAuthentication += (o, e) => { e.Accept = true; }; dtlsclient.RemotePort = 8765; dtlsclient.RemoteHost = "HostNameOrIPAddress"; dtlsclient.Connect(); dtlsclient.SendText("Hello!");

To send binary data, use the SendBytes method 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 (DTLSClient Class)

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Address;
  int Port;
  int StatusCode;
  const char *Description;
  int reserved;
} DTLSClientConnectedEventParams;


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

typedef struct {
  LPCWSTR Address;
  INT Port;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} DTLSClientConnectedEventParams;

#define EID_DTLSCLIENT_CONNECTED 1

virtual INT IPWORKSDTLS_CALL FireConnected(LPSTR &lpszAddress, INT &iPort, INT &iStatusCode, LPSTR &lpszDescription);

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

  int Port();

  int StatusCode();

  const QString &Description();

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

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

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

Remarks

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

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

If the connection is broken for any other reason, StatusCode will be non-zero, and the Description parameter will contain a description of this code.

DataIn Event (DTLSClient Class)

This event is fired when data are received.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Datagram;
  int lenDatagram;
  const char *SourceAddress;
  int SourcePort;
  int reserved;
} DTLSClientDataInEventParams;


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

typedef struct {
  LPCSTR Datagram;
  INT lenDatagram;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT reserved;
} DTLSClientDataInEventParams;

#define EID_DTLSCLIENT_DATAIN 2

virtual INT IPWORKSDTLS_CALL FireDataIn(LPSTR &lpDatagram, INT &lenDatagram, LPSTR &lpszSourceAddress, INT &iSourcePort);

class DTLSClientDataInEventParams {
public:
  const QByteArray &Datagram();

  const QString &SourceAddress();

  int SourcePort();

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

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

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

Remarks

The DataIn event is fired every time a new datagram is received.

Datagram contains the packet as sent by the remote host.

SourceAddress contains the IP number (Internet address) of the remote host, and SourcePort contains the port from which the packet originated.

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

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Address;
  int Port;
  int StatusCode;
  const char *Description;
  int reserved;
} DTLSClientDisconnectedEventParams;


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

typedef struct {
  LPCWSTR Address;
  INT Port;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} DTLSClientDisconnectedEventParams;

#define EID_DTLSCLIENT_DISCONNECTED 3

virtual INT IPWORKSDTLS_CALL FireDisconnected(LPSTR &lpszAddress, INT &iPort, INT &iStatusCode, LPSTR &lpszDescription);

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

  int Port();

  int StatusCode();

  const QString &Description();

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

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

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

Remarks

This event is fired when a connection is closed.

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

If the connection is broken for any other reason, StatusCode will be non-zero, and the Description parameter will contain a description of this code.

Error Event (DTLSClient Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DTLSCLIENT_ERROR 4

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

class DTLSClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass DTLSClient and override this emitter function.
virtual int FireError(DTLSClientErrorEventParams *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.

Log Event (DTLSClient Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} DTLSClientLogEventParams;

#define EID_DTLSCLIENT_LOG 5

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

class DTLSClientLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

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

Remarks

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

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including users logging in and out, files transferred, and directories listed.

The value 2 (Verbose) includes logs from the PITrail event as well as basic information about data transfer channels.

The value 3 (Debug) logs additional debug information, such as extended socket connection and data transfer information.

Message is the log entry.

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

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

SSLServerAuthentication Event (DTLSClient Class)

This event is fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DTLSCLIENT_SSLSERVERAUTHENTICATION 6

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

class DTLSClientSSLServerAuthenticationEventParams {
public:
  const QString &SourceAddress();

  int SourcePort();

  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(DTLSClientSSLServerAuthenticationEventParams *e);

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

Remarks

This event is fired after the server presents its certificate to the client.

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_DTLSCLIENT_SSLSTATUS 7

virtual INT IPWORKSDTLS_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

// Or, subclass DTLSClient and override this emitter function.
virtual int FireSSLStatus(DTLSClientSSLStatusEventParams *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

IPWorksDTLSCertificate (declared in ipworksdtls.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)

Config Settings (DTLSClient Class)

DTLSClient Config Settings

UDP Config Settings

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

DTLSClient Errors