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 Observer
ECLConnection is the base class from which ECLSession inherits. An application must use an instance of ECLSession to access the methods in this class.


Method Index

 o GetCICSGWCodePage()
Gets the user-specified CICS gateway codepage.
 o GetCICSServer()
Gets the name of CICS server.
 o GetCodePage()
Gets the host code page.
 o GetConnType()
Gets the session type.
 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 IsCommStarted()
Checks if the session is connected to the host.
 o RegisterCommEvent(ECLCommNotify, boolean)
Registers a notification object for events dispatched by a single instance of ECLComm.
 o StartCommunication()
Starts the communications link to the host.
 o StopCommunication()
Stops the communications link to the host.
 o UnregisterCommEvent(ECLCommNotify)
Unregisters a notification object previously registered with the RegisterCommEvent() method.
 o update(Observable, Object)
Method called to turn tracing on or off for this class.

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.

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

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

Returns:
True if the Session is started. False otherwise.
 o StartCommunication
 public synchronized void StartCommunication()
Starts the communications link to the host.

 o StopCommunication
 public synchronized void StopCommunication()
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 ECLComm. The notification object must implement the ECLCommNotify interface which defines three callback methods called by the ECLComm 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 GetCICSServer
 public String GetCICSServer()
Gets the name of CICS server.

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

Returns:
The user-specified CICS gateway code page.
 o update
 public void update(Observable o,
                    Object arg)
Method called to turn tracing on or off for this class.


All Packages  Class Hierarchy  This Package  Previous  Next  Index