Telnet Class

Properties   Methods   Events   Config Settings   Errors  

The Telnet Class is used to communicate with servers implementing the TELNET protocol.

Syntax

Telnet

Remarks

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

The Telnet Class provides a simple interface to Telnet communications as specified by RFC 854. It allows sending of Telnet command codes to remote Telnet servers, and it scans the input data for Telnet commands. Appropriate events are fired for received commands.

The connection interface is very similar to that of TCPClient. The same properties and events are used for sending and receiving normal data, and the same property set is used to set properties of the connection. The Telnet Class adds a number of methods like SendCommand, SendDoOption, and others that allow for sending of Telnet commands to the other end. The respective events (e.g., Command, Do) are fired when the corresponding Telnet commands are received.

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

This property indicates whether data reception is currently enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();

Unicode (Windows)
BOOL GetAcceptData();

int ipworks_telnet_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 (Telnet 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 ipworks_telnet_getbytessent(void* lpObj);

int GetBytesSent();

Default Value

0

Remarks

The BytesSent property shows how many bytes were sent after the last call to SendBytes or SendUrgentBytes. Please check the SendBytes method for more information.

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

Data Type

Integer

Connected Property (Telnet Class)

This property indicates whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

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

Firewall Property (Telnet Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworks_telnet_getfirewallautodetect(void* lpObj);
int ipworks_telnet_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_telnet_getfirewalltype(void* lpObj);
int ipworks_telnet_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_telnet_getfirewallhost(void* lpObj);
int ipworks_telnet_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_telnet_getfirewallpassword(void* lpObj);
int ipworks_telnet_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_telnet_getfirewallport(void* lpObj);
int ipworks_telnet_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_telnet_getfirewalluser(void* lpObj);
int ipworks_telnet_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

IPWorksFirewall

KeepAlive Property (Telnet 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 ipworks_telnet_getkeepalive(void* lpObj);
int ipworks_telnet_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 (Telnet 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 ipworks_telnet_getlinger(void* lpObj);
int ipworks_telnet_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 (Telnet 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* ipworks_telnet_getlocalhost(void* lpObj);
int ipworks_telnet_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 (Telnet Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworks_telnet_getlocalport(void* lpObj);
int ipworks_telnet_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

The LocalPort 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 it to 0 (default) enables the 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 a connection is made. Any attempt to set the LocalPort property when a connection is active will generate an error.

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

Data Type

Integer

RemoteHost Property (Telnet 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* ipworks_telnet_getremotehost(void* lpObj);
int ipworks_telnet_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 (Telnet Class)

This property includes the secure Telnet port in the remote host (default is 23).

Syntax

• C++
• C
• Qt

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

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

int ipworks_telnet_getremoteport(void* lpObj);
int ipworks_telnet_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

23

Remarks

For the implicit Secure Sockets Layer (SSL), use port 992 (for more information, please refer to the SSLStartMode property).

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.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCert Property (Telnet Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworks_telnet_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_telnet_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_telnet_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_telnet_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_telnet_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_telnet_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_telnet_getsslacceptservercertissuer(void* lpObj);

char* ipworks_telnet_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_telnet_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_telnet_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_telnet_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_telnet_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_telnet_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_telnet_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_telnet_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_telnet_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_telnet_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_telnet_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_telnet_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_telnet_getsslacceptservercertstoretype(void* lpObj);
int ipworks_telnet_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_telnet_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_telnet_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_telnet_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_telnet_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_telnet_getsslacceptservercertusage(void* lpObj);

int ipworks_telnet_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_telnet_getsslacceptservercertversion(void* lpObj);

char* ipworks_telnet_getsslacceptservercertsubject(void* lpObj);
int ipworks_telnet_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

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

IPWorksCertificate

SSLCert Property (Telnet Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworks_telnet_getsslcerteffectivedate(void* lpObj);

char* ipworks_telnet_getsslcertexpirationdate(void* lpObj);

char* ipworks_telnet_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_telnet_getsslcertfingerprint(void* lpObj);

char* ipworks_telnet_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_telnet_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_telnet_getsslcertissuer(void* lpObj);

char* ipworks_telnet_getsslcertprivatekey(void* lpObj);

int ipworks_telnet_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_telnet_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_telnet_getsslcertpublickey(void* lpObj);

char* ipworks_telnet_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_telnet_getsslcertpublickeylength(void* lpObj);

char* ipworks_telnet_getsslcertserialnumber(void* lpObj);

char* ipworks_telnet_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_telnet_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_telnet_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_telnet_getsslcertstorepassword(void* lpObj);
int ipworks_telnet_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_telnet_getsslcertstoretype(void* lpObj);
int ipworks_telnet_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_telnet_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_telnet_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_telnet_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_telnet_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_telnet_getsslcertusage(void* lpObj);

int ipworks_telnet_getsslcertusageflags(void* lpObj);

char* ipworks_telnet_getsslcertversion(void* lpObj);

char* ipworks_telnet_getsslcertsubject(void* lpObj);
int ipworks_telnet_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

IPWorksCertificate

SSLEnabled Property (Telnet Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_telnet_getsslenabled(void* lpObj);
int ipworks_telnet_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (Telnet 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 ipworks_telnet_getsslprovider(void* lpObj);
int ipworks_telnet_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 (Telnet Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_telnet_getsslservercerteffectivedate(void* lpObj);

char* ipworks_telnet_getsslservercertexpirationdate(void* lpObj);

char* ipworks_telnet_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_telnet_getsslservercertfingerprint(void* lpObj);

char* ipworks_telnet_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_telnet_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_telnet_getsslservercertissuer(void* lpObj);

char* ipworks_telnet_getsslservercertprivatekey(void* lpObj);

int ipworks_telnet_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_telnet_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_telnet_getsslservercertpublickey(void* lpObj);

char* ipworks_telnet_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_telnet_getsslservercertpublickeylength(void* lpObj);

char* ipworks_telnet_getsslservercertserialnumber(void* lpObj);

char* ipworks_telnet_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworks_telnet_getsslservercertstorepassword(void* lpObj);

int ipworks_telnet_getsslservercertstoretype(void* lpObj);

char* ipworks_telnet_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_telnet_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_telnet_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_telnet_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_telnet_getsslservercertusage(void* lpObj);

int ipworks_telnet_getsslservercertusageflags(void* lpObj);

char* ipworks_telnet_getsslservercertversion(void* lpObj);

char* ipworks_telnet_getsslservercertsubject(void* lpObj);

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

IPWorksCertificate

SSLStartMode Property (Telnet Class)

This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);

SSL_AUTOMATIC(0), 
SSL_IMPLICIT(1), 
SSL_EXPLICIT(2), 
SSL_NONE(3)

int ipworks_telnet_getsslstartmode(void* lpObj);
int ipworks_telnet_setsslstartmode(void* lpObj, int iSSLStartMode);

int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode);

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (Telnet Class)

This property specifies 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 ipworks_telnet_gettimeout(void* lpObj);
int ipworks_telnet_settimeout(void* lpObj, int iTimeout);

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

Default Value

0

Remarks

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

If Timeout is set to a positive value, the class will automatically retry each operation that otherwise would result in a WOULDBLOCK error 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 0 (asynchronous operation).

Data Type

Integer

Transparent Property (Telnet Class)

When this property is True, Telnet command processing is disabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransparent();
int SetTransparent(int bTransparent);

Unicode (Windows)
BOOL GetTransparent();
INT SetTransparent(BOOL bTransparent);

int ipworks_telnet_gettransparent(void* lpObj);
int ipworks_telnet_settransparent(void* lpObj, int bTransparent);

bool GetTransparent();
int SetTransparent(bool bTransparent);

Default Value

FALSE

Remarks

The Transparent property allows you to enable or disable Telnet command processing. When command processing is disabled, any data received are provided with no modifications.

Data Type

Boolean

Config Method (Telnet 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* ipworks_telnet_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 (Telnet Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworks_telnet_connect(void* lpObj);

int Connect();

Remarks

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

To specify a nonstandard port number, set RemotePort before calling this method.

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

This method connects to a remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszHost);

int ipworks_telnet_connectto(void* lpObj, const char* lpszHost);

int ConnectTo(const QString& qsHost);

Remarks

This method connects to the remote host specified by the Host. For instance: component.Connect("MyTelnetServer");

To specify a nonstandard port number set RemotePort before calling this method.

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

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworks_telnet_disconnect(void* lpObj);

int Disconnect();

Remarks

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

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_telnet_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 (Telnet Class)

This method pauses data reception.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PauseData();

Unicode (Windows)
INT PauseData();

int ipworks_telnet_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 (Telnet 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 ipworks_telnet_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 (Telnet Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_telnet_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 (Telnet 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 ipworks_telnet_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.

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

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

SendCommand Method (Telnet Class)

This method sends a single-character Telnet command code to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCommand(int iCommand);

Unicode (Windows)
INT SendCommand(INT iCommand);

int ipworks_telnet_sendcommand(void* lpObj, int iCommand);

int SendCommand(int iCommand);

Remarks

This method sends the single-character command code specified by Command to the server. Codes for Telnet commands and their meanings are defined in the Telnet RFCs. Some common commands are as follows:

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

SendDontOption Method (Telnet Class)

This method sends a single-character Telnet option code to the server with the Telnet DONT command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendDontOption(int iDontOption);

Unicode (Windows)
INT SendDontOption(INT iDontOption);

int ipworks_telnet_senddontoption(void* lpObj, int iDontOption);

int SendDontOption(int iDontOption);

Remarks

For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

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

SendDoOption Method (Telnet Class)

This method sends a single-character Telnet option code to the server with the Telnet DO command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendDoOption(int iDoOption);

Unicode (Windows)
INT SendDoOption(INT iDoOption);

int ipworks_telnet_senddooption(void* lpObj, int iDoOption);

int SendDoOption(int iDoOption);

Remarks

For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

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

SendDoSubOption Method (Telnet Class)

This methods sends a Telnet SubOption to send to the server with the SubOption command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendDoSubOption(const char* lpDoSubOption, int lenDoSubOption);

Unicode (Windows)
INT SendDoSubOption(LPCSTR lpDoSubOption, INT lenDoSubOption);

int ipworks_telnet_senddosuboption(void* lpObj, const char* lpDoSubOption, int lenDoSubOption);

int SendDoSubOption(QByteArray qbaDoSubOption);

Remarks

Valid suboptions and their descriptions are defined in the Telnet RFCs.

For example, to send a terminal type suboption to request setting the terminal type to 'vt100', send ASCII 24, followed by ASCII 0, followed by vt100.

Suboption start and end codes are automatically added by the class.

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

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

SendUrgentBytes Method (Telnet Class)

This method urgently sends binary data to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendUrgentBytes(const char* lpUrgentBytes, int lenUrgentBytes);

Unicode (Windows)
INT SendUrgentBytes(LPCSTR lpUrgentBytes, INT lenUrgentBytes);

int ipworks_telnet_sendurgentbytes(void* lpObj, const char* lpUrgentBytes, int lenUrgentBytes);

int SendUrgentBytes(QByteArray qbaUrgentBytes);

Remarks

This method sends the bytes specified by UrgentBytes as urgent data (out-of-band) to the remote host. To send text urgently, use the SendUrgentText method instead.

Data sent using this method will bypass the normal Transmission Control Protocol (TCP) queuing mechanism. Use this method with caution.

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

SendUrgentText Method (Telnet Class)

This method urgently sends text to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendUrgentText(const char* lpszUrgentText);

Unicode (Windows)
INT SendUrgentText(LPCWSTR lpszUrgentText);

int ipworks_telnet_sendurgenttext(void* lpObj, const char* lpszUrgentText);

int SendUrgentText(const QString& qsUrgentText);

Remarks

This method sends the text specified by UrgentText as urgent data (out-of-band) to the remote host. To send binary data urgently, use the SendUrgentBytes method instead.

Data sent using this method will bypass the normal Transmission Control Protocol (TCP) queuing mechanism. Use this method with caution.

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

SendWillOption Method (Telnet Class)

This method sends a single-character Telnet option code the server with the Telnet WILL command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendWillOption(int iWillOption);

Unicode (Windows)
INT SendWillOption(INT iWillOption);

int ipworks_telnet_sendwilloption(void* lpObj, int iWillOption);

int SendWillOption(int iWillOption);

Remarks

For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

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

SendWontOption Method (Telnet Class)

This method sends a single-character Telnet option code to the server with the Telnet WONT command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendWontOption(int iWontOption);

Unicode (Windows)
INT SendWontOption(INT iWontOption);

int ipworks_telnet_sendwontoption(void* lpObj, int iWontOption);

int SendWontOption(int iWontOption);

Remarks

For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

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

Command Event (Telnet Class)

This event is fired when a Telnet command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCommand(TelnetCommandEventParams *e);

typedef struct {
  int CommandCode;
  int reserved;
} TelnetCommandEventParams;


Unicode (Windows)
virtual INT FireCommand(TelnetCommandEventParams *e);

typedef struct {
  INT CommandCode;
  INT reserved;
} TelnetCommandEventParams;

#define EID_TELNET_COMMAND 1

virtual INT IPWORKS_CALL FireCommand(INT &iCommandCode);

class TelnetCommandEventParams {
public:
  int CommandCode();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireCommand(TelnetCommandEventParams *e) {...}

Remarks

Codes for Telnet commands and their meanings are defined in the Telnet RFCs. Following are some examples:

Connected Event (Telnet Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_CONNECTED 2

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

class TelnetConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_CONNECTIONSTATUS 3

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

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

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

This event is fired when data are received from the remote host.

Syntax

• C++
• C
• Qt

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

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


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

typedef struct {
  LPCSTR Text;
  INT lenText;
  INT reserved;
} TelnetDataInEventParams;

#define EID_TELNET_DATAIN 4

virtual INT IPWORKS_CALL FireDataIn(LPSTR &lpText, INT &lenText);

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

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

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

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

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection. Incoming data are provided through the Text parameter.

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

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_DISCONNECTED 5

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

class TelnetDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireDisconnected(TelnetDisconnectedEventParams *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.

Do Event (Telnet Class)

This event is fired when a Telnet DO OPTION command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDo(TelnetDoEventParams *e);

typedef struct {
  int OptionCode;
  int reserved;
} TelnetDoEventParams;


Unicode (Windows)
virtual INT FireDo(TelnetDoEventParams *e);

typedef struct {
  INT OptionCode;
  INT reserved;
} TelnetDoEventParams;

#define EID_TELNET_DO 6

virtual INT IPWORKS_CALL FireDo(INT &iOptionCode);

class TelnetDoEventParams {
public:
  int OptionCode();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireDo(TelnetDoEventParams *e) {...}

Remarks

The OptionCode parameter identifies the option code. For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

Dont Event (Telnet Class)

This event is fired when a Telnet DONT OPTION command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDont(TelnetDontEventParams *e);

typedef struct {
  int OptionCode;
  int reserved;
} TelnetDontEventParams;


Unicode (Windows)
virtual INT FireDont(TelnetDontEventParams *e);

typedef struct {
  INT OptionCode;
  INT reserved;
} TelnetDontEventParams;

#define EID_TELNET_DONT 7

virtual INT IPWORKS_CALL FireDont(INT &iOptionCode);

class TelnetDontEventParams {
public:
  int OptionCode();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireDont(TelnetDontEventParams *e) {...}

Remarks

The OptionCode parameter identifies the option code. For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

Error Event (Telnet Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_ERROR 8

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

class TelnetErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

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

Syntax

• C++
• C
• Qt

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

typedef struct {
  int reserved;
} TelnetReadyToSendEventParams;


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

typedef struct {
  INT reserved;
} TelnetReadyToSendEventParams;

#define EID_TELNET_READYTOSEND 9

virtual INT IPWORKS_CALL FireReadyToSend();

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

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

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

Remarks

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

SSLServerAuthentication Event (Telnet Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_SSLSERVERAUTHENTICATION 10

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

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

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_TELNET_SSLSTATUS 11

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SubOption Event (Telnet Class)

This event is fired when a Telnet SubOption command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubOption(TelnetSubOptionEventParams *e);

typedef struct {
  const char *SubOption;
  int lenSubOption;
  int reserved;
} TelnetSubOptionEventParams;


Unicode (Windows)
virtual INT FireSubOption(TelnetSubOptionEventParams *e);

typedef struct {
  LPCSTR SubOption;
  INT lenSubOption;
  INT reserved;
} TelnetSubOptionEventParams;

#define EID_TELNET_SUBOPTION 12

virtual INT IPWORKS_CALL FireSubOption(LPSTR &lpSubOption, INT &lenSubOption);

class TelnetSubOptionEventParams {
public:
  const QByteArray &SubOption();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireSubOption(TelnetSubOptionEventParams *e) {...}

Remarks

The SubOption parameter contains the suboption data as sent by the other end. The enclosing suboption command codes are stripped away.

For a list of valid Telnet suboptions and their descriptions, please look at the Telnet RFCs.

Will Event (Telnet Class)

This event is fired when a Telnet WILL OPTION command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWill(TelnetWillEventParams *e);

typedef struct {
  int OptionCode;
  int reserved;
} TelnetWillEventParams;


Unicode (Windows)
virtual INT FireWill(TelnetWillEventParams *e);

typedef struct {
  INT OptionCode;
  INT reserved;
} TelnetWillEventParams;

#define EID_TELNET_WILL 13

virtual INT IPWORKS_CALL FireWill(INT &iOptionCode);

class TelnetWillEventParams {
public:
  int OptionCode();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireWill(TelnetWillEventParams *e) {...}

Remarks

For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

Wont Event (Telnet Class)

This event is fired when a Telnet WONT OPTION command comes from the Telnet server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWont(TelnetWontEventParams *e);

typedef struct {
  int OptionCode;
  int reserved;
} TelnetWontEventParams;


Unicode (Windows)
virtual INT FireWont(TelnetWontEventParams *e);

typedef struct {
  INT OptionCode;
  INT reserved;
} TelnetWontEventParams;

#define EID_TELNET_WONT 14

virtual INT IPWORKS_CALL FireWont(INT &iOptionCode);

class TelnetWontEventParams {
public:
  int OptionCode();

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

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

// Or, subclass Telnet and override this emitter function.
virtual int FireWont(TelnetWontEventParams *e) {...}

Remarks

The OptionCode parameter identifies the option code. For a list of option codes and their descriptions, please look at the Telnet RFCs. Following are a few examples:

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.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

IPWorksFirewall (declared in ipworks.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 (Telnet 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 (Telnet 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.

Telnet Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors