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.
-
CONNECTION_ACTIVE
-
-
CONNECTION_DEVICE_NAME_READY
-
-
CONNECTION_INACTIVE
-
-
CONNECTION_INIT
-
-
CONNECTION_PND_ACTIVE
-
-
CONNECTION_PND_INACTIVE
-
-
CONNECTION_READY
-
-
CONNECTION_WORKSTATION_ID_READY
-
-
GetCICSGWCodePage()
- Gets the user-specified CICS gateway code page.
-
GetCICSServer()
- Gets the name of CICS server.
-
GetCodePage()
- Gets the host code page.
-
GetCommStatus()
- Returns the status of the connection to the host
-
GetConnType()
- Gets the session type.
-
GetDeviceName()
- Returns the device (or LU) name associated with this session.
-
GetHost()
- Gets the name of the host with which the session is established.
-
GetName()
- Gets the session name.
-
GetPort()
- Gets the host port number of the session.
-
getPrinterName()
- Returns the printer device name.
-
getPrintFileName()
- Returns the print file name if output is directed to a file.
-
getProperties()
- Return the Properties object used when constructing this session.
-
GetWorkstationID()
- Returns the name of a workstation ID for this session.
-
IsCommReady()
- Checks whether the session is ready for interaction such as sending
keystrokes or calling other API methods.
-
IsCommStarted()
- Checks whether the session is connected to the host.
-
IsDeviceNameReady()
- Checks whether the negotiated device name is ready.
-
isENPTUI()
- Returns whether or not the ENPTUI function should be enabled for 5250 display session.
-
isPrintDestination()
- Determines if the print destination is a printer or a file
This is only valid for VT sessions.
-
isSeparateFiles()
- Determines if each print job goes to a unique file or have printer jobs
appended to each other in one file.
-
isTCPNODELAY()
- Returns the setting of the TCPNODELAY configuration option.
-
IsWorkstationIDReady()
- Checks whether the negotiated workstation ID is ready.
-
RegisterCommEvent(ECLCommNotify, boolean)
- Registers a notification object for events dispatched by a single
instance of ECLConnection.
-
StartCommunication()
- Starts the communications link to the host.
-
StopCommunication()
-
-
syncStopCommunication()
- Stops the communications link to the host.
-
UnregisterCommEvent(ECLCommNotify)
- Unregisters a notification object previously registered with the
RegisterCommEvent() method.
CONNECTION_INIT
public static final int CONNECTION_INIT
CONNECTION_PND_INACTIVE
public static final int CONNECTION_PND_INACTIVE
CONNECTION_INACTIVE
public static final int CONNECTION_INACTIVE
CONNECTION_PND_ACTIVE
public static final int CONNECTION_PND_ACTIVE
CONNECTION_ACTIVE
public static final int CONNECTION_ACTIVE
CONNECTION_READY
public static final int CONNECTION_READY
CONNECTION_DEVICE_NAME_READY
public static final int CONNECTION_DEVICE_NAME_READY
CONNECTION_WORKSTATION_ID_READY
public static final int CONNECTION_WORKSTATION_ID_READY
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.
GetName
public String GetName()
- Gets the session name.
- Returns:
- The session name.
GetCodePage
public int GetCodePage()
- Gets the host code page.
- Returns:
- The code page in use on the host.
GetHost
public String GetHost()
- Gets the name of the host with which the session is established.
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.
GetPort
public int GetPort()
- Gets the host port number of the session.
This method is only supported by Host On-Demand.
- Returns:
- The host port number.
IsCommStarted
public boolean IsCommStarted()
- Checks whether the session is connected to the host.
- Returns:
- True if the Session is started. False otherwise.
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.
GetCommStatus
public int GetCommStatus()
- Returns the status of the connection to the host
- Returns:
- The status of the connection
IsDeviceNameReady
public boolean IsDeviceNameReady()
- Checks whether the negotiated device name is ready.
This is only valid for 3270 session.
This method is only supported by Host On-Demand.
- Returns:
- Returns true if the device name is ready.
- See Also:
- GetDeviceName
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.
This method is only supported by Host On-Demand.
- Returns:
- The assigned device name, or null if one has not been
assigned.
- See Also:
- IsDeviceNameReady
IsWorkstationIDReady
public boolean IsWorkstationIDReady()
- Checks whether the negotiated workstation ID is ready.
This is only valid for 5250 session.
This method is only supported by Host On-Demand.
- Returns:
- Returns true if the workstation ID is ready.
- See Also:
- GetDeviceName
GetWorkstationID
public String GetWorkstationID()
- Returns the name of a workstation ID for this session.
This is only valid for 5250 session.
This method is only supported by Host On-Demand.
- Returns:
- The workstation ID for 5250, or null if one has not been
specified.
StartCommunication
public synchronized void StartCommunication()
- Starts the communications link to the host.
StopCommunication
public void StopCommunication()
syncStopCommunication
public synchronized void syncStopCommunication()
- Stops the communications link to the host.
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
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
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.
GetCICSServer
public String GetCICSServer()
- Gets the name of CICS server.
This method is only supported by Host On-Demand.
- Returns:
- The CICS Server name.
GetCICSGWCodePage
public int GetCICSGWCodePage()
- Gets the user-specified CICS gateway code page.
This method is only supported by Host On-Demand.
- Returns:
- The user-specified CICS gateway code page.
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.
isENPTUI
public boolean isENPTUI()
- Returns whether or not the ENPTUI function should be enabled for 5250 display session.
isPrintDestination
public boolean isPrintDestination()
- Determines if the print destination is a printer or a file
This is only valid for VT sessions.
This method is only supported by Host On-Demand.
- Returns:
- Returns true if the destination is a printer
getPrintFileName
public String getPrintFileName()
- Returns the print file name if output is directed to a file.
This method is only supported by Host On-Demand.
- Returns:
- Returns the print file name or null if output is a printer.
getPrinterName
public String getPrinterName()
- Returns the printer device name.
This method is only supported by Host On-Demand.
- Returns:
- Returns the printer device or null if output is to a file.
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.
This 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