Search: 
Available in: IP*WORKS! | SSH | SSL
Telnet Class
Telnet Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The Telnet component 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 IPPort. 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 component 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 component with short descriptions. Click on the links for complete descriptions.

AcceptData Enables or disables data reception (the DataIn event).
BytesSent The number of bytes actually sent after an assignment to DataToSend.
Command A single character Telnet command code to be sent to the server.
Connected Triggers a connection or disconnection.
DataToSend A string of data to be sent to the remote host.
DoOption A single character Telnet option code to be sent to the server with the Telnet DO command.
DoSubOption A Telnet suboption to send to the server with the suboption command.
DontOption A single character Telnet option code to be sent to the server with the Telnet DONT command.
Firewall A set of properties related to firewall access.
KeepAlive When True, KEEPALIVE packets are enabled (for long connections).
Linger When set to True, connections are terminated gracefully.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort The TCP port in the local host where IPPort binds.
RemoteHost The address of the remote host. Domain names are resolved to IP addresses.
RemotePort The Telnet port in the remote host (default is 23).
Timeout A timeout for the component.
Transparent When True, Telnet command processing is disabled.
UrgentData A string of data to be sent urgently (out-of-band) to the remote host.
WillOption A single character Telnet option code to be sent to the server with the Telnet WILL command.
WontOption A single character Telnet option code to be sent to the server with the Telnet WONT command.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
Connect Connect to a remote host.
Disconnect Disconnect from the remote host.
DoEvents Processes events from the internal message queue.
Send Send data to the remote host.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Command Fired when a Telnet command comes from the Telnet server.
Connected Fired immediately after a connection completes (or fails).
ConnectionStatus Fired to indicate changes in connection state.
DataIn Fired when data is received from the remote host.
Disconnected Fired when a connection is closed.
Do Fired when a Telnet DO OPTION command comes from the Telnet server.
Dont Fired when a Telnet DONT OPTION command comes from the Telnet server.
Error Information about errors during data delivery.
ReadyToSend Fired when the component is ready to send data.
SubOption Fired when a Telnet suboption command comes from the Telnet server.
Will Fired when a Telnet WILL OPTION command comes from the Telnet server.
Wont Fired when a Telnet WONT OPTION command comes from the Telnet server.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
InBufferSize The size in bytes of the incoming queue of the socket.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
TcpNoDelay Whether or not to delay when sending packets

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.