IP*Works! V9

ipworks
Class Telnet

java.lang.Object
  extended by ipworks.Telnet

public class Telnet
extends java.lang.Object

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

The Telnet Bean 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 Bean 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.


Constructor Summary
Telnet()
          Creates an instance of Telnet Bean.
Telnet(java.lang.String runtimeLicense)
          Creates an instance of Telnet Bean with specified run-time license.
 
Method Summary
 void addTelnetEventListener(TelnetEventListener l)
           
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a configuration setting.
 void connect(java.lang.String host)
          Connect to a remote host.
 void disconnect()
          Disconnect from the remote host.
 void doEvents()
          Processes events from the internal message queue.
 int getBytesSent()
          The number of bytes actually sent after an assignment to DataToSend .
 Firewall getFirewall()
          A set of properties related to firewall access.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 int getLocalPort()
          The TCP port in the local host where IPPort binds.
 java.lang.String getRemoteHost()
          The address of the remote host.
 int getRemotePort()
          The Telnet port in the remote host (default is 23).
 int getTimeout()
          A timeout for the bean.
 boolean isAcceptData()
          Enables or disables data reception (the DataIn event).
 boolean isConnected()
          Triggers a connection or disconnection.
 boolean isKeepAlive()
          When True, KEEPALIVE packets are enabled (for long connections).
 boolean isLinger()
          When set to True, connections are terminated gracefully.
 boolean isTransparent()
          When True, Telnet command processing is disabled.
 void removeTelnetEventListener(TelnetEventListener l)
           
 void send(byte[] text)
          Send data to the remote host.
 void setAcceptData(boolean acceptData)
          Enables or disables data reception (the DataIn event).
 void setCommand(int command)
          A single character Telnet command code to be sent to the server.
 void setConnected(boolean connected)
          Triggers a connection or disconnection.
 void setDataToSend(byte[] dataToSend)
          A string of data to be sent to the remote host.
 void setDontOption(int dontOption)
          A single character Telnet option code to be sent to the server with the Telnet DONT command.
 void setDoOption(int doOption)
          A single character Telnet option code to be sent to the server with the Telnet DO command.
 void setDoSubOption(byte[] doSubOption)
          A Telnet SubOption to send to the server with the SubOption command.
 void setFirewall(Firewall firewall)
          A set of properties related to firewall access.
 void setKeepAlive(boolean keepAlive)
          When True, KEEPALIVE packets are enabled (for long connections).
 void setLinger(boolean linger)
          When set to True, connections are terminated gracefully.
 void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 void setLocalPort(int localPort)
          The TCP port in the local host where IPPort binds.
 void setRemoteHost(java.lang.String remoteHost)
          The address of the remote host.
 void setRemotePort(int remotePort)
          The Telnet port in the remote host (default is 23).
 void setTimeout(int timeout)
          A timeout for the bean.
 void setTransparent(boolean transparent)
          When True, Telnet command processing is disabled.
 void setUrgentData(byte[] urgentData)
          A string of data to be sent urgently (out-of-band) to the remote host.
 void setWillOption(int willOption)
          A single character Telnet option code to be sent to the server with the Telnet WILL command.
 void setWontOption(int wontOption)
          A single character Telnet option code to be sent to the server with the Telnet WONT command.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Telnet

public Telnet()
Creates an instance of Telnet Bean.


Telnet

public Telnet(java.lang.String runtimeLicense)
Creates an instance of Telnet Bean with specified run-time license.

Method Detail

isAcceptData

public boolean isAcceptData()
Enables or disables data reception (the DataIn event).

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, re-enables data reception.


setAcceptData

public void setAcceptData(boolean acceptData)
                   throws IPWorksException
Enables or disables data reception (the DataIn event).

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, re-enables data reception.

Throws:
IPWorksException

getBytesSent

public int getBytesSent()
The number of bytes actually sent after an assignment to DataToSend .

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.


setCommand

public void setCommand(int command)
                throws IPWorksException
A single character Telnet command code to be sent to the server.

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

241 (NOP)
No operation.
242 (Data Mark)
The data stream portion of a Synch. This should always be accompanied by a TCP Urgent notification.
243 (Break)
NVT character BRK.
244 (Interrupt Process)
The function IP.
245 (Abort Output)
The function AO.
246 (Are You There)
The function AYT.
247 (Erase Character)
The function EC.
248 (Erase Line)
The function EL.
249 (Go Ahead)
The GA signal.

Throws:
IPWorksException

isConnected

public boolean isConnected()
Triggers a connection or disconnection.

Setting the Connected property to True makes the bean 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.


setConnected

public void setConnected(boolean connected)
                  throws IPWorksException
Triggers a connection or disconnection.

Setting the Connected property to True makes the bean 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.

Throws:
IPWorksException

setDataToSend

public void setDataToSend(byte[] dataToSend)
                   throws IPWorksException
A string of data to be sent to the remote host.

Assigning a string to the DataToSend property makes the bean 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, DataToSend fails with exception 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. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

Throws:
IPWorksException

setDontOption

public void setDontOption(int dontOption)
                   throws IPWorksException
A single character Telnet option code to be sent to the server with the Telnet DONT command.

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

0 (TRANSMIT-BINARY)
Enables or disables binary (8 bit) transmission.
1 (ECHO)
Telnet ECHO option. Specifies whether bytes sent should be echoed or not.
3 (SUPPRESS-GO-AHEAD)
Used to enable or disable transmission of the Telnet GO_AHEAD command.
24 (TERMINAL-TYPE)
Allows or disallows terminal type negotiation.
31 (NAWS)
Allows or disallows window size negotiation.

Throws:
IPWorksException

setDoOption

public void setDoOption(int doOption)
                 throws IPWorksException
A single character Telnet option code to be sent to the server with the Telnet DO command.

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

0 (TRANSMIT-BINARY)
Enables or disables binary (8 bit) transmission.
1 (ECHO)
Telnet ECHO option. Specifies whether bytes sent should be echoed or not.
3 (SUPPRESS-GO-AHEAD)
Used to enable or disable transmission of the Telnet GO_AHEAD command.
24 (TERMINAL-TYPE)
Allows or disallows terminal type negotiation.
31 (NAWS)
Allows or disallows window size negotiation.

Throws:
IPWorksException

setDoSubOption

public void setDoSubOption(byte[] doSubOption)
                    throws IPWorksException
A Telnet SubOption to send to the server with the SubOption command.

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

Throws:
IPWorksException

getFirewall

public Firewall getFirewall()
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.


setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksException
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:
IPWorksException

isKeepAlive

public boolean isKeepAlive()
When True, KEEPALIVE packets are enabled (for long connections).

The KeepAlive enables the SO_KEEPALIVE option on the socket. This option prevents long connections from timing out in case of inactivity.

Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE.


setKeepAlive

public void setKeepAlive(boolean keepAlive)
                  throws IPWorksException
When True, KEEPALIVE packets are enabled (for long connections).

The KeepAlive enables the SO_KEEPALIVE option on the socket. This option prevents long connections from timing out in case of inactivity.

Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE.

Throws:
IPWorksException

isLinger

public boolean isLinger()
When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 bean returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.


setLinger

public void setLinger(boolean linger)
               throws IPWorksException
When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 bean returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

Throws:
IPWorksException

getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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 bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean 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.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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 bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean 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.

Throws:
IPWorksException

getLocalPort

public int getLocalPort()
The TCP port in the local host where IPPort binds.

The LocalPort property must be set before a connection is attempted. It instructs the bean 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.


setLocalPort

public void setLocalPort(int localPort)
                  throws IPWorksException
The TCP port in the local host where IPPort binds.

The LocalPort property must be set before a connection is attempted. It instructs the bean 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.

Throws:
IPWorksException

getRemoteHost

public java.lang.String getRemoteHost()
The address of the remote host. Domain names are resolved to IP addresses.

This property specifies the IP address (IP number in dotted internet format) or 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 bean 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)

 IPPortControl.RemoteHost = "MyHostNameOrIP"
 IPPortControl.RemotePort = 777
 IPPortControl.Connected = true 


setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)
                   throws IPWorksException
The address of the remote host. Domain names are resolved to IP addresses.

This property specifies the IP address (IP number in dotted internet format) or 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 bean 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)

 IPPortControl.RemoteHost = "MyHostNameOrIP"
 IPPortControl.RemotePort = 777
 IPPortControl.Connected = true 

Throws:
IPWorksException

getRemotePort

public int getRemotePort()
The Telnet port in the remote host (default is 23).

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.


setRemotePort

public void setRemotePort(int remotePort)
                   throws IPWorksException
The Telnet port in the remote host (default is 23).

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.

Throws:
IPWorksException

getTimeout

public int getTimeout()
A timeout for the bean.

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 bean will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The bean 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 bean throws an exception.

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.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

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


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the bean.

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 bean will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The bean 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 bean throws an exception.

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.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

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

Throws:
IPWorksException

isTransparent

public boolean isTransparent()
When True, Telnet command processing is disabled.

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.


setTransparent

public void setTransparent(boolean transparent)
                    throws IPWorksException
When True, Telnet command processing is disabled.

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.

Throws:
IPWorksException

setUrgentData

public void setUrgentData(byte[] urgentData)
                   throws IPWorksException
A string of data to be sent urgently (out-of-band) to the remote host.

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.

Throws:
IPWorksException

setWillOption

public void setWillOption(int willOption)
                   throws IPWorksException
A single character Telnet option code to be sent to the server with the Telnet WILL command.

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

0 (TRANSMIT-BINARY)
Enables or disables binary (8 bit) transmission.
1 (ECHO)
Telnet ECHO option. Specifies whether bytes sent should be echoed or not.
3 (SUPPRESS-GO-AHEAD)
Used to enable or disable transmission of the Telnet GO_AHEAD command.
24 (TERMINAL-TYPE)
Allows or disallows terminal type negotiation.
31 (NAWS)
Allows or disallows window size negotiation.

Throws:
IPWorksException

setWontOption

public void setWontOption(int wontOption)
                   throws IPWorksException
A single character Telnet option code to be sent to the server with the Telnet WONT command.

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

0 (TRANSMIT-BINARY)
Enables or disables binary (8 bit) transmission.
1 (ECHO)
Telnet ECHO option. Specifies whether bytes sent should be echoed or not.
3 (SUPPRESS-GO-AHEAD)
Used to enable or disable transmission of the Telnet GO_AHEAD command.
24 (TERMINAL-TYPE)
Allows or disallows terminal type negotiation.
31 (NAWS)
Allows or disallows window size negotiation.

Throws:
IPWorksException

config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException
Sets or retrieves a configuration setting.

Config is a generic method available in every bean. It is used to set and retrieve configuration settings for the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, 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.

The bean accepts one or more of the following configuration settings . Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, access to these internal properties is provided through the Config method.

IPPort Configuration Settings

FirewallAutoDetect
Tells the bean whether or not to automatically detect and use firewall system settings, if available
This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallHost
Name or IP address of firewall (optional)
If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener
If true, the component binds to a SOCKS firewall as a server (IPPort only)
This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost , and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword
Password to be used if authentication is to be used when connecting through the firewall
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort
The TCP port for the FirewallHost;
Note that the FirewallPort is set automatically when FirewallType is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType
Determines the type of firewall to connect through
The appropriate values are as follows:
0
No firewall (default setting).
1
Connect through a tunneling proxy. FirewallPort is set to 80.
2
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser
A user name if authentication is to be used connecting through a firewall
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime
The inactivity time in milliseconds before a TCP keep-alive packet is sent
When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received
When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger
When set to True, connections are terminated gracefully
This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 bean returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime
Time in seconds to have the connection linger
LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.
LocalHost
The name of the local host through which connections are initiated or accepted
The LocalHost setting 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 bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost setting 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).

LocalPort
The TCP port in the local host where the bean binds
This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength
The maximum amount of data to accumulate when no EOL is found
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate
The transfer rate limit in bytes per second
This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.
TCPKeepAlive
Determines whether or not the keep alive socket option is enabled
If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6
Whether or not to use IPv6
By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.
CloseStreamAfterTransfer
If true, the component will close the upload or download stream after the transfer
This entry is for bean and all the components that descend from it.This property is true by default. Therefore, by default, all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, you must set this config to false.

TcpNoDelay
Whether or not to delay when sending packets
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

Socket Configuration Settings

AbsoluteTimeout
Determines whether timeouts are inactivity timeouts or absolute timeouts
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
FirewallData
Used to send extra data to the firewall
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
InBufferSize
The size in bytes of the incoming queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize
The size in bytes of the outgoing queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable
Tells the bean whether or not a message loop is available for processing events
In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

Throws:
IPWorksException

connect

public void connect(java.lang.String host)
             throws IPWorksException
Connect to a remote host.

Calling this method is equivalent to setting the RemoteHost property to Host and then setting the Connected property to True.

Throws:
IPWorksException

disconnect

public void disconnect()
                throws IPWorksException
Disconnect from the remote host.

Calling this method is equivalent to setting the Connected property to False.

Throws:
IPWorksException

doEvents

public void doEvents()
              throws IPWorksException
Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Throws:
IPWorksException

send

public void send(byte[] text)
          throws IPWorksException
Send data to the remote host.

Calling this method is equivalent to setting the DataToSend property to Text .

Throws:
IPWorksException

addTelnetEventListener

public void addTelnetEventListener(TelnetEventListener l)
                            throws java.util.TooManyListenersException
Throws:
java.util.TooManyListenersException

removeTelnetEventListener

public void removeTelnetEventListener(TelnetEventListener l)

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.