Dart Telnet Control
Telnet Object Members
Overview 
Public Methods
Public Method AbortClose the connection abruptly and release all outstanding buffers (events do not fire).
Public Method AboutDisplay Telnet control information in a dialog box.
Public Method CloseClose the session and release all system resources. A single control can be used for many connections, one after the other.
Public Method ConnectEstablish a connection. The State property immediately changes to tcpConnecting and changes to tcpConnected when the connection is established, the security protocol is negotiated and authentication succeeds. The State property can be checked in the body of the State Event, polled off a timer, or checked immediately after this method is used when a positive Timeout is specified.
Public Method ReceiveReceive an arbitrary amount of data. The specified String or Byte array is filled with bytes from the remote host.
Public Method RexecUses the remote execute protocol common to UNIX systems, which is intended to execute commands on a remote UNIX host. User and Password must match an account on the remote host.
Public Method RloginUses the remote login protocol common to UNIX systems, which is similar to Telnet but simpler. It does not require Telnet option negotiation because it was intended for use between two UNIX systems.
Public Method RshUses the remote shell protocol common to UNIX systems, which is intended to execute shell commands on a remote UNIX host. This method differs from the Rexec method (which implements the remote execute protocol) by being faster and not requiring a full login. For full description of the remote shell protocol, see the UNIX man pages.
Public Method Search

Receive data up to and including a terminating sequence. The data stream is searched for the specified Token, and the specified string, byte array, or DartStream object is filled with the data stream up to and including the specified Token.

This method is useful for processing variable-length records or lines that are defined by known delimiter strings.

Public Method SendSend data after a connection is established. The Send event fires when Data is accepted by the system buffers. The SendBufferCount property indicates the number of bytes that have been submitted but have not yet been accepted by the system buffers.
Public Method SendCommandSend a Telnet command sequence. The Telnet Control ensures all formatting is accomplished correctly. This method is normally called from within the Command event.
Public Method Trace

Start or stop the accumulation of trace or debug data. Once started, this method accumulates data until it is turned off.

This method provides a convenient mechanism for viewing all data being sent and received over the connection and can be used to troubleshoot host interoperability issues and expose protocol communications.

Public Properties
Public Property AutoOptionEnables automatic option negotiation.
Public Property BinarySpecifies whether or not to negotiate TRANSMIT-BINARY when the AutoOption property is True.
Public Property BlockedA True value indicates the control is currently executing a blocking method (Timeout is greater than 0), which has neither completed nor timed out with a ptTimeout error.
Public Property EchoIndicates that the remote host should echo all Telnet data it receives back to the client.
Public Property KeepAliveWhen set to True, the KEEPALIVE socket option is set to monitor dropped connections. This option can only be set when the State property is tcpConnected.
Public Property LocalAddressWhen the State property is tcpConnected, LocalAddress returns the address of the local host in dot notation (for example, nnn.nnn.nnn.nnn). When not connected, it returns an empty string.
Public Property LocalPortWhen the State property is tcpConnected, LocalPort returns the port number that the socket is bound to. When not connected, it returns 0.
Public Property ReceiveBufferCountChecks for the existence of data without removing it.
Public Property RefStores a reference to another object, data type, or value.
Public Property RemoteAddressReturns the address of the remote host in dot notation (i.e. nnn.nnn.nnn.nnn) when the State property is tcpConnected.
Public Property RemotePortReturns the port number of the remote host when the State property is tcpConnected.
Public Property SendBufferCountWhen the Send method is used, some data may be stored in a buffer and later submitted to the system. The Send event fires to indicate that the system has accepted the submitted data.
Public Property SocketSystem identifier assigned to the TCP connection.
Public Property StateProvides status information to the user interface. The State event fires to signal that this property has changed.
Public Property TermTypeTerminal emulation type to negotiate to when AutoOption is True.
Public Property TimeoutControls the blocking behavior of methods that can be used in blocking and non-blocking ways.
Public Property WindowSizeSpecifies the desired window size when the AutoOption property is True.
Events
Public Event CommandWhen the AutoOption property is set to False, the Telnet Control does not respond to Telnet commands, but instead fires the Command event. The application must have the appropriate code within this event to handle all option negotiation. The presence of this event allows the user to write sophisticated Telnet clients that can support any desired option, as well as Telnet server applications. The SendCommand method is used to send Telnet option negotiation sequences and commands.
Public Event ErrorFires when an error condition occurs.
Public Event ReceiveFires when ReceiveBufferCount changes.
Public Event SendFires when the system accepts data for sending.
Public Event StateFires when the State property changes.
See Also

Telnet Object


Documentation Version 1.9.3.0
© 2020 Dart Communications. All Rights Reserved.
Send comments on this topic