Interface IAtmSession

The Session object handles the communication flow from the host datastream.

Namespace: Attachmate.Verastream.HostIntegrator.EAO2V

Assembly: Attachmate.Verastream.HostIntegrator.EAO2V.dll

Syntax

[ComVisible(true)]
public interface IAtmSession

Remarks

The Session represents a logical host session. EAO2V maps all calls to a VHI session.

A Session has two sub-objects as properties: a Connection object and a Screen object. The Connection object contains the configuration information for the session, and the Screen object contains the screen-related information and functionality.

The EAO2V Session object does not support events.

Properties

Attached

In Host Integrator, this property has no function.

Declaration

bool Attached { get; set; }

Property Value

Type	Description
bool

Connected

The connection state of the session. If the session is not already connected and Connected is set to True, the session will be connected in a synchronous process.

Declaration

bool Connected { get; set; }

Property Value

Type	Description
bool

Connection

The connection object associated with this session, or Null if no connection is associated with the session. Must be set prior to Connect(object, object). Note: The session object has no default connection; you must first create the connection object then assign it to the session. In EAO2V, there is only one connection type: 3270 (see AtmConTN3270).

Declaration

IAtmConTN3270 Connection { get; set; }

Property Value

Type	Description
IAtmConTN3270

Screen

The emulation-specific screen object associated with this session, or Null if no screen is associated with the session. Must be set prior to Connect. Note: The session object has no default screen; you must first create the screen object and then assign it to the session. In EAO2V, there is currently only one screen type: 3270 (see AtmScreen3270).

Declaration

IAtmScreen3270 Screen { get; set; }

Property Value

Type	Description
IAtmScreen3270

SessionNameInUse

The name of the session: the VHI Session ID.

Declaration

string SessionNameInUse { get; }

Property Value

Type	Description
string

State

Session State. Return ATM_SS_UNATTACHED (1) if not connected, or ATM_SS_CONNECTED (20) if connected.

Declaration

ATM_SESSION_STATE State { get; }

Property Value

Type	Description
ATM_SESSION_STATE

VhiSession

The VHI session that is backing this Extra Session.

Declaration

[ComVisible(false)]
HostIntegratorRejuvenationSession VhiSession { get; }

Property Value

Type	Description
HostIntegratorRejuvenationSession

Methods

Connect(object, object)

Connects the session. Before connecting, you must set a Connection object, and this Connection object must have valid values for Properties RemoteHostAddress and DestinationPort. Additionally, you must set the property Name to the VHI session server host name and optionally the model name. By default, the connection will be made using model "Terminal3270".

Declaration

IAtmWait Connect(object inReserved = null, object inWaitOption = null)

Parameters

Type	Name	Description
object	inReserved	ignored.
object	inWaitOption	ignored. The connection is synchronous.

Returns

Type	Description
IAtmWait	A wait object that indicates success or failure.

Connect(HostIntegratorRejuvenationSession)

Encapsulate an already open VHI session.
This method is preferred, because it allows full access to features such as session pools, domains, model variables, security settings, and other models besides "Terminal3270". This method is only available in the EAO2V .NET interface, not in the COM interface.

Declaration

[ComVisible(false)]
void Connect(HostIntegratorRejuvenationSession session)

Parameters

Type	Name	Description
HostIntegratorRejuvenationSession	session	An already connected rejuvenation session.

Disconnect(object, object)

Disconnect the session.

Declaration

IAtmWait Disconnect(object inReserved = null, object inWaitOption = null)

Parameters

Type	Name	Description
object	inReserved	ignored.
object	inWaitOption	ignored.

Returns

Type	Description
IAtmWait	A wait object that indicates success.