Ict.Common.Remoting.Server.TClientTasksManager Class Reference

Handles Server-to-Client messaging. More...

Public Member Functions
	TClientTasksManager ()
	Initialises the DataTable that hold new and archived tasks (messages). More...
Boolean	Get_ClientTasksNewDataTableEmpty ()
	Property accessor. Gets called by KeepAlive to inquire if there are Tasks that need to be passed on to the Client. More...
Int32	ClientTaskAdd (String ATaskGroup, String ATaskCode, object ATaskParameter1, object ATaskParameter2, object ATaskParameter3, object ATaskParameter4, Int16 ATaskPriority)
	Adds a Client Task. More...
String	ClientTaskStatus (System.Int64 ATaskID)
	Returns the current Status of a Task. More...
DataTable	Get_ClientTasksNewDataTable ()
	Property accessor. Gets called by KeepAlive to get the Tasks that need to be passed on to the Client. Automatically moves these Tasks to the archive DataTable and sets their status from 'New' to 'Fetched'. More...

Properties
Boolean	ClientTasksNewDataTableEmpty [get]
	Gets called by KeepAlive to inquire if there are Tasks that need to be passed on to the Client. More...
DataTable	ClientTasksNewDataTable [get]
	Gets called by KeepAlive to get the Tasks that need to be passed on to the Client. Automatically moves these Tasks to the archive DataTable and sets their status from 'New' to 'Fetched'. More...

Detailed Description

Handles Server-to-Client messaging.

Tasks (Messages) can be added. These get queued until the Client makes a KeepAlive call, whereupon the new Task(s) are returned to the Client. These Tasks get archived in memory on the Server side (for later use, eg. in a workflow scenario).

Todo:

Not thread save yet!

Constructor & Destructor Documentation

TClientTasksManager()

Ict.Common.Remoting.Server.TClientTasksManager.TClientTasksManager ( )

inline

Initialises the DataTable that hold new and archived tasks (messages).

Returns

void

Member Function Documentation

ClientTaskAdd()

Int32 Ict.Common.Remoting.Server.TClientTasksManager.ClientTaskAdd ( String  ATaskGroup, String  ATaskCode, object  ATaskParameter1, object  ATaskParameter2, object  ATaskParameter3, object  ATaskParameter4, Int16  ATaskPriority  )

inline

Adds a Client Task.

Parameters

ATaskGroup	Task Group (eg. USERMESSAGE, CACHEREFRESH)
ATaskCode	Task Code (eg. User message text, Cache table to refresh)
ATaskParameter1	Task Parameter1 (currently ignored on Client side)
ATaskParameter2	Task Parameter2 (currently ignored on Client side)
ATaskParameter3	Task Parameter3 (currently ignored on Client side)
ATaskParameter4	Task Parameter4 (currently ignored on Client side)
ATaskPriority	Task Priority (currently ignored on Client side)

TaskID

Returns

void

ClientTaskStatus()

String Ict.Common.Remoting.Server.TClientTasksManager.ClientTaskStatus ( System.Int64  ATaskID )

inline

Returns the current Status of a Task.

Parameters

ATaskID

Task ID

Returns

void

Get_ClientTasksNewDataTable()

DataTable Ict.Common.Remoting.Server.TClientTasksManager.Get_ClientTasksNewDataTable ( )

inline

Property accessor. Gets called by KeepAlive to get the Tasks that need to be passed on to the Client. Automatically moves these Tasks to the archive DataTable and sets their status from 'New' to 'Fetched'.

Returns

void

Get_ClientTasksNewDataTableEmpty()

Boolean Ict.Common.Remoting.Server.TClientTasksManager.Get_ClientTasksNewDataTableEmpty ( )

inline

Property accessor. Gets called by KeepAlive to inquire if there are Tasks that need to be passed on to the Client.

Returns

void

Property Documentation

ClientTasksNewDataTable

DataTable Ict.Common.Remoting.Server.TClientTasksManager.ClientTasksNewDataTable

get

Gets called by KeepAlive to get the Tasks that need to be passed on to the Client. Automatically moves these Tasks to the archive DataTable and sets their status from 'New' to 'Fetched'.

ClientTasksNewDataTableEmpty

Boolean Ict.Common.Remoting.Server.TClientTasksManager.ClientTasksNewDataTableEmpty

get

Gets called by KeepAlive to inquire if there are Tasks that need to be passed on to the Client.

---

The documentation for this class was generated from the following file:

• csharp/ICT/Common/Remoting/Server/ClientTasksManager.cs