Difference between revisions of "TTnCnx"

From Overbyte
Jump to navigation Jump to search
(event display fixed)
 
(11 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
== Overview ==
 
== Overview ==
'''TTnCnx''' implements a Telnet connection.
+
'''Unit''' [[OverbyteIcsTnCnx.pas|OverbyteIcsTnCnx.pas]]
 +
 
 +
'''TTnCnx''' implements Telnet options negotiations on a TWSocket connection, inherits from [[TIcsWndControl|TIcsWndControl]].
  
 
== Properties ==
 
== Properties ==
 
{|
 
{|
 
| valign="top" width="150" | [[TTnCnx.Host | Host]] |||| Used to set.  
 
| valign="top" width="150" | [[TTnCnx.Host | Host]] |||| Used to set.  
 +
|-
 +
| valign="top" | [[TTnCnx.LocalAddr | LocalAddr]] |||| Local Address for IPv4.
 +
|-
 +
| valign="top" | [[TTnCnx.LocalAddr6 | LocalAddr6]] |||| Local Address for IPv6.
 
|-
 
|-
 
| valign="top" | [[TTnCnx.LocalEcho | LocalEcho]] |||| Display sent characters on local side as well?.
 
| valign="top" | [[TTnCnx.LocalEcho | LocalEcho]] |||| Display sent characters on local side as well?.
 +
|-
 +
| valign="top" | [[TTnCnx.Handle | Handle]] |||| Window handle.
 
|-
 
|-
 
| valign="top" | [[TTnCnx.Location | Location]] |||| ?.
 
| valign="top" | [[TTnCnx.Location | Location]] |||| ?.
Line 15: Line 23:
 
|-
 
|-
 
| valign="top" | [[TTnCnx.Port | Port]] |||| Port on the server side where the connection is made to.
 
| valign="top" | [[TTnCnx.Port | Port]] |||| Port on the server side where the connection is made to.
 +
|-
 +
| valign="top" | [[TTnCnx.State | State]] |||| Status of the socket used.
 +
|-
 +
| valign="top" | [[TWSocket | Socket]] |||| The socket used internally.
 
|-
 
|-
 
| valign="top" | [[TTnCnx.Tag | Tag]] |||| Integer property for free usage.
 
| valign="top" | [[TTnCnx.Tag | Tag]] |||| Integer property for free usage.
Line 22: Line 34:
  
 
== Methods ==
 
== Methods ==
 +
{|
 +
| valign="top" | [[TTnCnx.Close | Close]] |||| Close the connection.
 +
|-
 +
| valign="top" | [[TTnCnx.Connect | Connect]] |||| Connect to a server.
 +
|-
 +
| valign="top" width="150" | [[TTnCnx.Create | Create]] |||| Create the instance.
 +
|-
 +
| valign="top" | [[TTnCnx.Destroy | Destroy]] |||| Free the instance.
 +
|-
 +
| valign="top" | [[TTnCnx.DontOption | DontOption]] |||| ?.
 +
|-
 +
| valign="top" | [[TTnCnx.DoOption | DoOption]] |||| ?.
 +
|-
 +
| valign="top" | [[TTnCnx.IsConnected | IsConnected]] |||| Does a connection exist?.
 +
|-
 +
| valign="top" | [[TTnCnx.Notification | Notification]] |||| ?.
 +
|-
 +
| valign="top" | [[TTnCnx.Pause | Pause]] |||| Pause socket operations.
 +
|-
 +
| valign="top" | [[TTnCnx.Resume | Resume]] |||| Resume socket operations after a Pause.
 +
|-
 +
| valign="top" | [[TTnCnx.WillOption | WillOption]] |||| ?.
 +
|-
 +
| valign="top" | [[TTnCnx.WontOption | WontOption]] |||| ?.
 +
|}
  
 
== Events ==
 
== Events ==
 
{|
 
{|
| valign="top" width="150" | [[TTnCnx.OnSessionConnected | OnSessionConnected]] |||| Raised upon succesfull connection of a session
+
| valign="top" | [[TTnCnx.OnDisplay | OnDisplay]] |||| Called when there is disconnect or error ???.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnSessionClosed | OnSessionClosed]] |||| Raised after a close of the existing connection.
+
| valign="top" | [[TTnCnx.OnEndOfRecord | OnEndOfRecord]] |||| Called when the end of a record is reached.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnDataAvailable | OnDataAvailable]] |||| Raised when data has been received.
+
| valign="top" | [[TTnCnx.OnLocalEcho | OnLocalEcho]] |||| Called when server has set local echo state.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnDisplay | OnDisplay]] |||| ?.
+
| valign="top" | [[TTnCnx.OnSendLoc | OnSendLoc]] |||| Called when server requests location information.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnEndOfRecord | OnEndOfRecord]] |||| Raised when the end of a record is reached?.
+
| valign="top" | [[TTnCnx.OnTermType | OnTermType]] |||| Called when server requests the type of the terminal.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnSendLoc | OnSendLoc]] |||| ?.
+
| valign="top" width="150" | [[TTnCnx.OnSessionConnected | OnSessionConnected]] |||| Called upon successful connection of a session.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnTermType | OnTermType]] |||| Raised when the type of the terminal has changed?.
+
| valign="top" | [[TTnCnx.OnDataAvailable | OnDataAvailable]] |||| Called when data has been received.
 
|-
 
|-
| valign="top" | [[TTnCnx.OnLocalEcho | OnLocalEcho]] |||| Raised when ?.
+
| valign="top" | [[TTnCnx.OnSessionClosed | OnSessionClosed]] |||| Called after a close of the existing connection.
 
|}
 
|}

Latest revision as of 22:38, 28 January 2019

Main page -> ICS components reference -> TTnCnx

Overview

Unit OverbyteIcsTnCnx.pas

TTnCnx implements Telnet options negotiations on a TWSocket connection, inherits from TIcsWndControl.

Properties

Host Used to set.
LocalAddr Local Address for IPv4.
LocalAddr6 Local Address for IPv6.
LocalEcho Display sent characters on local side as well?.
Handle Window handle.
Location ?.
Name Name of the instance.
Port Port on the server side where the connection is made to.
State Status of the socket used.
Socket The socket used internally.
Tag Integer property for free usage.
TermType Type of the terminal (internally used command language).

Methods

Close Close the connection.
Connect Connect to a server.
Create Create the instance.
Destroy Free the instance.
DontOption ?.
DoOption ?.
IsConnected Does a connection exist?.
Notification ?.
Pause Pause socket operations.
Resume Resume socket operations after a Pause.
WillOption ?.
WontOption ?.

Events

OnDisplay Called when there is disconnect or error ???.
OnEndOfRecord Called when the end of a record is reached.
OnLocalEcho Called when server has set local echo state.
OnSendLoc Called when server requests location information.
OnTermType Called when server requests the type of the terminal.
OnSessionConnected Called upon successful connection of a session.
OnDataAvailable Called when data has been received.
OnSessionClosed Called after a close of the existing connection.