IConnection Interface

The IConnection interface is used to establish a session and manage a connection to the runtime system.

Namespace: ABSuite.AccessLayer.Connector.Core
Assembly: Unisys.ABSuite.AccessLayer.Connector.Core (in Unisys.ABSuite.AccessLayer.Connector.Core.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public interface IConnection : IMethodExecuter

Public Interface IConnection
	Inherits IMethodExecuter

public interface class IConnection : IMethodExecuter

type IConnection =  
    interface
        interface IMethodExecuter
    end

The IConnection type exposes the following members.

Properties

	Name	Description
	DataHandler	The DataHandler retrieves an object for handling the data being exchanged with the runtime system. See the IRtConnection interface reference for details on its supported methods and properties.
	IsBusy	Retrives the current busy state of the connection.
	IsConnected	Retrieved the current connected state of the connection.
	Logger	Returns the Logging object to the client
	MessagesHandler	The MessagesHandler retrieves an object for handling unsolicited messages from the runtime system. See the IUnsolicitedMessages interface reference for details on its supported methods and properties.
	SessionId	Returns an integer value that contains the session id for the connection.
	Status	Holds the current status information sent by the runtime system

Top

Methods

	Name	Description
	Call	The Call method is used to execute a specified Public Method defined in the AB Suite system (Inherited from IMethodExecuter.)
	CallAsync	(Inherited from IMethodExecuter.)
	Close	The Close method will close the current connection to the Runtime system
	Connect	Connect Method establishes a connection with the Runtime System. This method is a synchronous call which will block the client application calling it. Use the ConnectAsync() method if you do not want a blocking call.
	ConnectAsync	ConnectAsync Method establishes a connection with the Runtime System. This method is an asynchronous call which will not block the client application that is calling it. When the ConnectAsync method completes, it will execute the callback passed for the "complete" parameter. Use the Connect() method if you require a blocking call.
	GetDataModelObject	Retrieve a new TransmissionObject containing a DataModel instance of the specified Ispec/Class
	Load	Loads a specified ispec/class in the runtime system for this session. This is a synchronous call. The calling process will be blocked until the method completes.
	LoadAsync	Loads a specified ispec/class in the runtime system for this session. This is an asynchronous call. The calling process will not block. An event handler for the complete event will receive the new TransmissionObject when the call completes.
	ProcessColonCommand	The ProcessColonCommand sends a colon command to the Runtime system
	ProcessColonCommandAsync

Top

Events

	Name	Description
	ChangeLocaleRequest	The ChangeLocaleRequest event is triggered when a language change occurs in the runtime system
	ChangeSystemRequest	The ChangeSystemRequest event is triggered when the runtime system performs a Switch to another system.
	CloseRequest	The CloseRequest event is triggered when the runtime system closes the session with the client
	ConnectionProgressStatus	The ConnectionProgressStatus event is triggered when the state of the connection progress changes.
	DownLoadComplete	The DownLoadComplete event is triggered when the required assemblies for the client session have been downloaded successfully.
	DuplicateLoginRequest	The DuplicateLoginRequest event is triggered when the runtime system detects that the user requesting a session has already been logged into the system.
	IsBusyChanged	The IsBusyChanged event is triggered when a change occurs in the Busy state for the connecttion.
	ProcessTransactionErrors	The ProcessTransactionErrors event is triggered when the runtime system returns error messages to the client session
	SetCursorRequest	The SetCursorRequest event is triggered when the runtime system sets the focus to a field in the current DataModel
	ShowTeachRequest	The ShowTeachRequest event is triggered when the runtime system requests the view for a teach class to be displayed
	StatusChanged	The StatusChanged event is triggered when the status information is updated by the runtime system.
	TransmissionObjectChanged	The TransmissionObjectChanged event is triggered when the response from the runtime system requires a different DataModel to be used, instead of the current DataModel

Top

Reference

ABSuite.AccessLayer.Connector.Core Namespace