1.0.0

org.eclipse.soda.dk.tcpip.connection
Class TcpipConnection

java.lang.Object
  extended by org.eclipse.soda.dk.core.EscObject
      extended by org.eclipse.soda.dk.connection.Connection
          extended by org.eclipse.soda.dk.connection.StreamConnection
              extended by org.eclipse.soda.dk.tcpip.connection.TcpipConnection
All Implemented Interfaces:
ConnectionService, TcpipConnectionService

public class TcpipConnection
extends StreamConnection
implements TcpipConnectionService, ConnectionService

The TcpipConnection class implements the ConnectionService interface.

Version:
1.0.0
See Also:
ConnectionService, InetAddress, Socket, String

Field Summary
static java.lang.String[] TO_STRING_CONFIGURATION_KEYS
          Define the to string configuration keys (String[]) constant.
 
Fields inherited from class org.eclipse.soda.dk.connection.Connection
CLIENT_WAIT_RESOURCE, CLOSE_RESOURCE, CLOSED_RESOURCE, configurationService, OPEN_RESOURCE, OPENFAILED_RESOURCE, READ_BYTES_RESOURCE, WRITE_BYTES_RESOURCE
 
Fields inherited from class org.eclipse.soda.dk.core.EscObject
CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, INTEGER_TABLE, KEY_KEY, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_TRACE, LOG_WARNING, PREFIX_KEY, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE
 
Fields inherited from interface org.eclipse.soda.dk.tcpip.connection.service.TcpipConnectionService
CONNECTION_TYPE, DEFAULT_HOST, DEFAULT_LINGER, DEFAULT_LOCALPORT, DEFAULT_READSIZE, DEFAULT_READTIMEOUT, DEFAULT_REMOTEPORT, DEFAULT_WRITESIZE, FACTORY_SERVICE_NAME, HOST_KEY, LINGER_KEY, LOCALPORT_KEY, READSIZE_KEY, READTIMEOUT_KEY, REMOTEPORT_KEY, SERVICE_NAME, WRITESIZE_KEY
 
Fields inherited from interface org.eclipse.soda.dk.connection.service.ConnectionService
CONNECTION_KEY, DEFAULT_CONNECTION
 
Constructor Summary
TcpipConnection(ConfigurationService configuration)
          Constructs an instance of this class from the specified configuration parameter.
TcpipConnection(java.util.Dictionary properties)
          Constructs an instance of this class from the specified properties parameter.
TcpipConnection(java.net.Socket port)
          Constructs an TcpipConnection object using the input parameter(s).
TcpipConnection(java.lang.String targetHost, int targetPort)
          Constructs an TcpipConnection object using the input parameter(s).
TcpipConnection(java.lang.String targetHost, int targetPort, int localPort)
          Constructs an TcpipConnection object using the input parameter(s).
TcpipConnection(java.lang.String targetHost, int targetPort, int localPort, int timeout)
          Insert the method's description here.
TcpipConnection(java.lang.String targetHost, int targetPort, int localPort, int timeout, int sendBufferSize, int receiveBufferSize)
          Constructs an instance of this class from the specified target host, target port, local port, timeout, send buffer size and receive buffer size parameters.
TcpipConnection(java.lang.String targetHost, int targetPort, int localPort, int timeout, int sendBufferSize, int receiveBufferSize, int linger)
          Constructs an instance of this class from the specified target host, target port, local port, timeout, send buffer size, receive buffer size and linger parameters.
 
Method Summary
 void close()
          Perform the close action method.
 void exit()
          Exit.
 java.net.Socket getPort()
          Gets the port (Socket) value.
 boolean isOpen()
          Gets the open (boolean) value.
 void open()
          Perform the open action method.
 void setPort(java.net.Socket port)
          Sets the port value.
 void toStringInfo(java.lang.StringBuffer buffer)
          To string info with the specified buffer parameter.
 
Methods inherited from class org.eclipse.soda.dk.connection.StreamConnection
flush, getInputStream, getOutputStream, read, read, setInputStream, setOutputStream, write, write
 
Methods inherited from class org.eclipse.soda.dk.connection.Connection
attemptRecoveryFromError, finalize, getConfigurationService, getDefaultResource, getErrorSeverity, getResource, setConfigurationService, setOpen
 
Methods inherited from class org.eclipse.soda.dk.core.EscObject
createDefaultLogService, createException, createException, createInteger, createIntegerTable, createNumber, format, getBoolean, getCurrentTimestamp, getDefaultLogService, getFloat, getInt, getLoadLibraryName, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogService, getLong, getObject, getOutputName, getSimpleClassName, getStaticBoolean, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleStaticError, handleStaticException, isDebug, isTrace, loadService, log, log, report, report, report, report, report, report, reportError, reportSystemInfo, setDebug, setDefaultLogService, setLogService, setTraceLevel, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.soda.dk.connection.service.ConnectionService
flush, read, read, write, write
 

Field Detail

TO_STRING_CONFIGURATION_KEYS

public static final java.lang.String[] TO_STRING_CONFIGURATION_KEYS
Define the to string configuration keys (String[]) constant.

Constructor Detail

TcpipConnection

public TcpipConnection(java.lang.String targetHost,
                       int targetPort)
Constructs an TcpipConnection object using the input parameter(s). java.lang.String int

Parameters:
targetHost - The target host (String) parameter.
targetPort - The target port (int) parameter.
See Also:
TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.lang.String targetHost,
                       int targetPort,
                       int localPort)
Constructs an TcpipConnection object using the input parameter(s). java.lang.String int int

Parameters:
targetHost - The target host (String) parameter.
targetPort - The target port (int) parameter.
localPort - The local port (int) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.lang.String targetHost,
                       int targetPort,
                       int localPort,
                       int timeout)
Insert the method's description here. Creation date: (4/10/00 9:31:45 AM) java.lang.String int int int

Parameters:
targetHost - The target host (String) parameter.
targetPort - The target port (int) parameter.
localPort - The local port (int) parameter.
timeout - The timeout (int) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.lang.String targetHost,
                       int targetPort,
                       int localPort,
                       int timeout,
                       int sendBufferSize,
                       int receiveBufferSize)
Constructs an instance of this class from the specified target host, target port, local port, timeout, send buffer size and receive buffer size parameters. The target host (String) parameter. The target port (int) parameter. The local port (int) parameter. The timeout (int) parameter. The send buffer size (int) parameter. The receive buffer size (int) parameter.

Parameters:
targetHost - The target host (String) parameter.
targetPort - The target port (int) parameter.
localPort - The local port (int) parameter.
timeout - The timeout (int) parameter.
sendBufferSize - The send buffer size (int) parameter.
receiveBufferSize - The receive buffer size (int) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.lang.String targetHost,
                       int targetPort,
                       int localPort,
                       int timeout,
                       int sendBufferSize,
                       int receiveBufferSize,
                       int linger)
Constructs an instance of this class from the specified target host, target port, local port, timeout, send buffer size, receive buffer size and linger parameters. The target host (String) parameter. The target port (int) parameter. The local port (int) parameter. The timeout (int) parameter. The send buffer size (int) parameter. The receive buffer size (int) parameter. The linger (int) parameter.

Parameters:
targetHost - The target host (String) parameter.
targetPort - The target port (int) parameter.
localPort - The local port (int) parameter.
timeout - The timeout (int) parameter.
sendBufferSize - The send buffer size (int) parameter.
receiveBufferSize - The receive buffer size (int) parameter.
linger - The linger (int) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.net.Socket port)
Constructs an TcpipConnection object using the input parameter(s). java.net.Socket

Parameters:
port - The port (Socket) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Dictionary), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(java.util.Dictionary properties)
Constructs an instance of this class from the specified properties parameter. The properties (Dictionary) parameter.

Parameters:
properties - The properties (Dictionary) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(ConfigurationService)

TcpipConnection

public TcpipConnection(ConfigurationService configuration)
Constructs an instance of this class from the specified configuration parameter. The configuration (ConfigurationService) parameter.

Parameters:
configuration - The configuration (ConfigurationService) parameter.
See Also:
TcpipConnection(String,int), TcpipConnection(String,int,int), TcpipConnection(String,int,int,int), TcpipConnection(String,int,int,int,int,int), TcpipConnection(String,int,int,int,int,int,int), TcpipConnection(Socket), TcpipConnection(Dictionary)
Method Detail

close

public void close()
           throws java.io.IOException
Perform the close action method. href="java.io.IOException.html">IOException Thrown if the IOException exception condition occurs.

Specified by:
close in interface ConnectionService
Overrides:
close in class StreamConnection
Throws:
java.io.IOException
See Also:
ConnectionService.close()

exit

public void exit()
          throws java.io.IOException
Exit.

Specified by:
exit in interface ConnectionService
Overrides:
exit in class Connection
Throws:
IOException.
java.io.IOException

getPort

public java.net.Socket getPort()
Gets the port (Socket) value.

Returns:
The port (Socket) value.
See Also:
setPort(Socket)

isOpen

public boolean isOpen()
Gets the open (boolean) value.

Specified by:
isOpen in interface ConnectionService
Overrides:
isOpen in class Connection
Returns:
The open (boolean) value.
See Also:
ConnectionService.isOpen(), Connection.setOpen(boolean)

open

public void open()
          throws java.io.IOException
Perform the open action method. href="java.io.IOException.html">IOException Thrown if the IOException exception condition occurs.

Specified by:
open in interface ConnectionService
Overrides:
open in class Connection
Throws:
java.io.IOException
See Also:
ConnectionService.open()

setPort

public void setPort(java.net.Socket port)
Sets the port value. The port (Socket) parameter.

Parameters:
port - The port (Socket) parameter.
See Also:
getPort()

toStringInfo

public void toStringInfo(java.lang.StringBuffer buffer)
To string info with the specified buffer parameter. The buffer (StringBuffer) parameter.

Overrides:
toStringInfo in class EscObject
Parameters:
buffer - The buffer (StringBuffer) parameter.

1.0.0

Copyright (c) 1999, 2007 IBM