All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.ECLConnection

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.ECLConnection

public class ECLConnection
extends Object
implements Runnable
ECLConnection is the base class from which ECLSession inherits. An application must use an instance of ECLSession to access the methods in this class.


Variable Index

 o CONNECTION_ACTIVE
 o CONNECTION_DEVICE_NAME_READY
 o CONNECTION_INACTIVE
 o CONNECTION_INIT
 o CONNECTION_PND_ACTIVE
 o CONNECTION_PND_INACTIVE
 o CONNECTION_READY
 o CONNECTION_WORKSTATION_ID_READY

Method Index

 o GetCICSGWCodePage()
Gets the user-specified CICS gateway code page.
 o GetCICSServer()
Gets the name of CICS server.
 o GetCodePage()
Gets the host code page.
 o GetCommStatus()
Returns the status of the connection to the host
 o GetConnType()
Gets the session type.
 o GetDeviceName()
Returns the device (or LU) name associated with this session.
 o GetHost()
Gets the name of the host with which the session is established.
 o GetName()
Gets the session name.
 o GetPort()
Gets the host port number of the session.
 o getPrinterName()
Returns the printer device name.
 o getPrintFileName()
Returns the print file name if output is directed to a file.
 o getProperties()
Return the Properties object used when constructing this session.
 o GetWorkstationID()
Returns the name of a workstation ID for this session.
 o IsCommReady()
Checks whether the session is ready for interaction such as sending keystrokes or calling other API methods.
 o IsCommStarted()
Checks whether the session is connected to the host.
 o IsDeviceNameReady()
Checks whether the negotiated device name is ready.
 o isENPTUI()
Returns whether or not the ENPTUI function should be enabled for 5250 display session.
 o isPrintDestination()
Determines if the print destination is a printer or a file This is only valid for VT sessions.
 o isSeparateFiles()
Determines if each print job goes to a unique file or have printer jobs appended to each other in one file.
 o isTCPNODELAY()
Returns the setting of the TCPNODELAY configuration option.
 o IsWorkstationIDReady()
Checks whether the negotiated workstation ID is ready.
 o RegisterCommEvent(ECLCommNotify, boolean)
Registers a notification object for events dispatched by a single instance of ECLConnection.
 o StartCommunication()
Starts the communications link to the host.
 o StopCommunication()
 o syncStopCommunication()
Stops the communications link to the host.
 o UnregisterCommEvent(ECLCommNotify)
Unregisters a notification object previously registered with the RegisterCommEvent() method.

Variables

 o CONNECTION_INIT
 public static final int CONNECTION_INIT
 o CONNECTION_PND_INACTIVE
 public static final int CONNECTION_PND_INACTIVE
 o CONNECTION_INACTIVE
 public static final int CONNECTION_INACTIVE
 o CONNECTION_PND_ACTIVE
 public static final int CONNECTION_PND_ACTIVE
 o CONNECTION_ACTIVE
 public static final int CONNECTION_ACTIVE
 o CONNECTION_READY
 public static final int CONNECTION_READY
 o CONNECTION_DEVICE_NAME_READY
 public static final int CONNECTION_DEVICE_NAME_READY
 o CONNECTION_WORKSTATION_ID_READY
 public static final int CONNECTION_WORKSTATION_ID_READY

Methods

 o GetConnType
 public int GetConnType()
Gets the session type.

Returns:
The session type. The value can be SESSION_TYPE_3270, SESSION_TYPE_5250, SESSION_TYPE_VT, or SESSION_TYPE_CICS.
 o GetName
 public String GetName()
Gets the session name.

Returns:
The session name.
 o GetCodePage
 public int GetCodePage()
Gets the host code page.

Returns:
The code page in use on the host.
 o GetHost
 public String GetHost()
Gets the name of the host with which the session is established.

PComm-unique For Personal Communications, the value returned by this method is the name of the .WS session configuration file.

Returns:
The name of the attached host.
 o GetPort
 public int GetPort()
Gets the host port number of the session.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
The host port number.
 o IsCommStarted
 public boolean IsCommStarted()
Checks whether the session is connected to the host.

Returns:
True if the Session is started. False otherwise.
 o IsCommReady
 public boolean IsCommReady()
Checks whether the session is ready for interaction such as sending keystrokes or calling other API methods.

Returns:
Returns true when the session is ready.
 o GetCommStatus
 public int GetCommStatus()
Returns the status of the connection to the host

Returns:
The status of the connection
 o IsDeviceNameReady
 public boolean IsDeviceNameReady()
Checks whether the negotiated device name is ready. This is only valid for 3270 session.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns true if the device name is ready.
See Also:
GetDeviceName
 o GetDeviceName
 public String GetDeviceName()
Returns the device (or LU) name associated with this session. The name is assigned by the host during session negotiation. This is only valid for 3270 session.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
The assigned device name, or null if one has not been assigned.
See Also:
IsDeviceNameReady
 o IsWorkstationIDReady
 public boolean IsWorkstationIDReady()
Checks whether the negotiated workstation ID is ready. This is only valid for 5250 session.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns true if the workstation ID is ready.
See Also:
GetDeviceName
 o GetWorkstationID
 public String GetWorkstationID()
Returns the name of a workstation ID for this session. This is only valid for 5250 session.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
The workstation ID for 5250, or null if one has not been specified.
 o StartCommunication
 public synchronized void StartCommunication()
Starts the communications link to the host.

 o StopCommunication
 public void StopCommunication()
 o syncStopCommunication
 public synchronized void syncStopCommunication()
Stops the communications link to the host.

 o RegisterCommEvent
 public void RegisterCommEvent(ECLCommNotify notify,
                               boolean initEvent)
Registers a notification object for events dispatched by a single instance of ECLConnection. The notification object must implement the ECLCommNotify interface which defines three callback methods called by the ECLConnection class under different conditions.

ECLCommNotify objects can be unregistered using the UnregisterCommEvent() method.

Parameters:
notify - ECLCommNotify object which is notified when events occur.
initEvent - Boolean indicating whether or not an initial notification should be sent out for the initial state of communications.
See Also:
UnregisterCommEvent, ECLCommNotify
 o UnregisterCommEvent
 public void UnregisterCommEvent(ECLCommNotify notify)
Unregisters a notification object previously registered with the RegisterCommEvent() method. If the notification object is not currently registered, this method does nothing.

Parameters:
notify - ECLCommNotify object which should be unregistered.
See Also:
RegisterCommEvent, ECLCommNotify
 o getProperties
 public Properties getProperties()
Return the Properties object used when constructing this session.

Returns:
A properties object. Contains a set of name/value pairs used when constructing this session.
 o GetCICSServer
 public String GetCICSServer()
Gets the name of CICS server.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
The CICS Server name.
 o GetCICSGWCodePage
 public int GetCICSGWCodePage()
Gets the user-specified CICS gateway code page.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
The user-specified CICS gateway code page.
 o isTCPNODELAY
 public boolean isTCPNODELAY()
Returns the setting of the TCPNODELAY configuration option. If this option is true, responses between this session and the telnet server will flow without any attempt to optimize for size. In some user situations, this will result in faster response time on the session. To turn on TCPNODELAY for a session, put an ECLSession.SESSION_TCP_NODELAY key with a value of ECLSession.SESSION_ON into the properties object passed to the ECLSession constructor.

Returns:
True if the TCPNODELAY option is being used when connecting to the Telnet server. Otherwise returns false.
 o isENPTUI
 public boolean isENPTUI()
Returns whether or not the ENPTUI function should be enabled for 5250 display session.

 o isPrintDestination
 public boolean isPrintDestination()
Determines if the print destination is a printer or a file This is only valid for VT sessions.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns true if the destination is a printer
 o getPrintFileName
 public String getPrintFileName()
Returns the print file name if output is directed to a file.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns the print file name or null if output is a printer.
 o getPrinterName
 public String getPrinterName()
Returns the printer device name.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns the printer device or null if output is to a file.
 o isSeparateFiles
 public boolean isSeparateFiles()
Determines if each print job goes to a unique file or have printer jobs appended to each other in one file. This is only valid for VT sessions.

HOD-uniqueThis method is only supported by Host On-Demand.

Returns:
Returns true when the print destination is a file and each printer job is written to a separate file.

All Packages  Class Hierarchy  This Package  Previous  Next  Index