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 SSL/TLS connections. When connecting over 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 via 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 for setting properties of the connection. The Telnet Class adds a number of properties like Command, DoOption, etc. which allow sending of Telnet commands to the other end. The respective events (Command, Do, etc.) 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 enables or disables data reception (the DataIn event).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAcceptData();
int SetAcceptData(int bAcceptData);

Unicode (Windows)
BOOL GetAcceptData();
INT SetAcceptData(BOOL bAcceptData);

int ipworksssl_telnet_getacceptdata(void* lpObj);
int ipworksssl_telnet_setacceptdata(void* lpObj, int bAcceptData);

bool GetAcceptData();
int SetAcceptData(bool bAcceptData);

Default Value

TRUE

Remarks

This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, reenables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

BytesSent Property (Telnet Class)

The number of bytes actually sent after an assignment to DataToSend .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBytesSent();

Unicode (Windows)
INT GetBytesSent();

int ipworksssl_telnet_getbytessent(void* lpObj);

int GetBytesSent();

Default Value

0

Remarks

The BytesSent property shows how many bytes were sent after the last assignment to DataToSend or UrgentData. Please check the DataToSend property for more information.

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

Data Type

Integer

Command Property (Telnet Class)

A single character Telnet command code to be sent to the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetCommand(INT iCommand);

int ipworksssl_telnet_setcommand(void* lpObj, int iCommand);

int SetCommand(int iCommand);

Default Value

0

Remarks

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

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

Data Type

Integer

Connected Property (Telnet Class)

Triggers a connection or disconnection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksssl_telnet_getconnected(void* lpObj);
int ipworksssl_telnet_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

Setting the Connected property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting Connected to False closes the connection. How and when the connection is closed is controlled by the Linger property.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DataToSend Property (Telnet Class)

A string of data to be sent to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDataToSend(const char* lpDataToSend, int lenDataToSend);

Unicode (Windows)
INT SetDataToSend(LPCSTR lpDataToSend, INT lenDataToSend);

int ipworksssl_telnet_setdatatosend(void* lpObj, const char* lpDataToSend, int lenDataToSend);

int SetDataToSend(QByteArray qbaDataToSend);

Default Value

""

Remarks

Assigning a string to the DataToSend property makes the class send the string to the remote host. The Send method provides similar functionality.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

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

Data Type

Binary String

DontOption Property (Telnet Class)

A single character Telnet option code to be sent to the server with the Telnet DONT command.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetDontOption(INT iDontOption);

int ipworksssl_telnet_setdontoption(void* lpObj, int iDontOption);

int SetDontOption(int iDontOption);

Default Value

0

Remarks

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

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

Data Type

Integer

DoOption Property (Telnet Class)

A single character Telnet option code to be sent to the server with the Telnet DO command.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetDoOption(INT iDoOption);

int ipworksssl_telnet_setdooption(void* lpObj, int iDoOption);

int SetDoOption(int iDoOption);

Default Value

0

Remarks

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

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

Data Type

Integer

DoSubOption Property (Telnet Class)

A Telnet SubOption to send to the server with the SubOption command.

Syntax

• C++
• C
• Qt

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

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

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

int SetDoSubOption(QByteArray qbaDoSubOption);

Default Value

""

Remarks

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

You don't need to specify the suboption start and suboption end codes. Those are appended automatically by the class. For example, to send a terminal type suboption to request setting the terminal type to 'vt100', you must send ASCII 24, followed by ASCII 0, followed by "vt100" (without the quotes).

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

Data Type

Binary String

FirewallAutoDetect Property (Telnet Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksssl_telnet_getfirewallautodetect(void* lpObj);
int ipworksssl_telnet_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (Telnet Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksssl_telnet_getfirewalltype(void* lpObj);
int ipworksssl_telnet_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (Telnet Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksssl_telnet_getfirewallhost(void* lpObj);
int ipworksssl_telnet_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (Telnet Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksssl_telnet_getfirewallpassword(void* lpObj);
int ipworksssl_telnet_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (Telnet Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksssl_telnet_getfirewallport(void* lpObj);
int ipworksssl_telnet_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (Telnet Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksssl_telnet_getfirewalluser(void* lpObj);
int ipworksssl_telnet_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

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 ipworksssl_telnet_getkeepalive(void* lpObj);
int ipworksssl_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 ipworksssl_telnet_getlinger(void* lpObj);
int ipworksssl_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* ipworksssl_telnet_getlocalhost(void* lpObj);
int ipworksssl_telnet_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (Telnet Class)

The TCP port in the local host where TCPClient binds.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_telnet_getlocalport(void* lpObj);
int ipworksssl_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* ipworksssl_telnet_getremotehost(void* lpObj);
int ipworksssl_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)

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 ipworksssl_telnet_getremoteport(void* lpObj);
int ipworksssl_telnet_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

23

Remarks

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

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

SSLAcceptServerCertEncoded Property (Telnet Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksssl_telnet_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksssl_telnet_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (Telnet Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksssl_telnet_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_telnet_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (Telnet Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksssl_telnet_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_telnet_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (Telnet Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksssl_telnet_getsslcertstorepassword(void* lpObj);
int ipworksssl_telnet_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Telnet Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksssl_telnet_getsslcertstoretype(void* lpObj);
int ipworksssl_telnet_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (Telnet Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksssl_telnet_getsslcertsubject(void* lpObj);
int ipworksssl_telnet_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLProvider Property (Telnet Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksssl_telnet_getsslprovider(void* lpObj);
int ipworksssl_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:

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

SSLServerCertEncoded Property (Telnet Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

SSLStartMode Property (Telnet Class)

Determines how the class starts the 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)

int ipworksssl_telnet_getsslstartmode(void* lpObj);
int ipworksssl_telnet_setsslstartmode(void* lpObj, int iSSLStartMode);

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

Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

Timeout Property (Telnet Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_telnet_gettimeout(void* lpObj);
int ipworksssl_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 can't be sent or received immediately.

If Timeout is set to a positive value, the class will automatically retry each operation that would otherwise 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 0 (asynchronous operation).

Data Type

Integer

Transparent Property (Telnet Class)

When 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 ipworksssl_telnet_gettransparent(void* lpObj);
int ipworksssl_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 is provided with no modifications.

Data Type

Boolean

UrgentData Property (Telnet Class)

A string of data to be sent urgently (out-of-band) to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUrgentData(const char* lpUrgentData, int lenUrgentData);

Unicode (Windows)
INT SetUrgentData(LPCSTR lpUrgentData, INT lenUrgentData);

int ipworksssl_telnet_seturgentdata(void* lpObj, const char* lpUrgentData, int lenUrgentData);

int SetUrgentData(QByteArray qbaUrgentData);

Default Value

""

Remarks

The UrgentData property behaves exactly like the DataToSend property except that the data is sent Out Of Band (urgent). This means that the data assigned to UrgentData will bypass the normal TCP queuing mechanism. Use this property with caution.

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

Data Type

Binary String

WillOption Property (Telnet Class)

A single character Telnet option code to be sent to the server with the Telnet WILL command.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetWillOption(INT iWillOption);

int ipworksssl_telnet_setwilloption(void* lpObj, int iWillOption);

int SetWillOption(int iWillOption);

Default Value

0

Remarks

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

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

Data Type

Integer

WontOption Property (Telnet Class)

A single character Telnet option code to be sent to the server with the Telnet WONT command.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SetWontOption(INT iWontOption);

int ipworksssl_telnet_setwontoption(void* lpObj, int iWontOption);

int SetWontOption(int iWontOption);

Default Value

0

Remarks

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

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

Data Type

Integer

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* ipworksssl_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)

Connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksssl_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 non-standard 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)

Connects to a remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszHost);

int ipworksssl_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 non-standard 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)

Disconnect from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksssl_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)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssl_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 ipworksssl_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 ipworksssl_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)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssl_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)

Sends binary data to the remote host.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_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)

Sends binary data to the remote host.

Syntax

• C++
• C
• Qt

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

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

int ipworksssl_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)

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 ipworksssl_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:

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

Sends text to the remote host.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT SendText(LPCWSTR lpszText);

int ipworksssl_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)

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

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

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 IPWORKSSSL_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. Here are some examples:

Connected Event (Telnet Class)

This event is 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 IPWORKSSSL_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)

This event is 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 IPWORKSSSL_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

The ConnectionStatus 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)

Fired when data is 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 IPWORKSSSL_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. The incoming data is 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)

This event is 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 IPWORKSSSL_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)

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 IPWORKSSSL_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. The following are a few examples:

Dont Event (Telnet Class)

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 IPWORKSSSL_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. The following are a few examples:

Error Event (Telnet Class)

Information 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 IPWORKSSSL_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)

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 IPWORKSSSL_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 TCP/IP subsystem is ready to accept data after a failed DataToSend. 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 IPWORKSSSL_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)

Shows the progress of the secure connection.

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

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

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 IPWORKSSSL_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. The following are a few examples:

Wont Event (Telnet Class)

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 IPWORKSSSL_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. The following are a few examples:

Config Settings (Telnet Class)

TCPClient Config Settings

SSL Config Settings

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

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
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.

SSLClient Errors

SSL Errors

TCP/IP Errors