.NET FAM_Queue class - Appistry EAF v3.8

Class FAM_Queue<T>

FAM_Session Session	This property specifies the session identifier. Only the get accessor is available for this property.
string Space	This property specifies the space identifier. Only the get accessor is available for this property.
string Key	This property specifies the key identifier. Only the get accessor is available for this property.
int Timeout	This property specifies the amount of time the client waits for a request to the FAM space to complete. The get and set accessors are available for this property.
int MaxRetries	This property specifies the maximum number of times the FAM space will retry a request. The get and set accessors are available for this property.

FAM_Queue<T>(string space,
             string key,
             FAM_Session famSession)

This is the FAM_Queue constructor.

void Push(T t)

This method adds data to the end of a queue.

T	generic data-type value or instance (see supported list)
Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

Boolean Pop(out T poppedValue)

This method returns data from the FAM space, removes the data from the queue, and places a lock on the FAM space.

T	generic data-type value or instance (see supported list)
boolean	TRUE indicates the data was removed from the queue, FALSE indicates the data was not removed from the queue
Exceptions	FAM_Exception FAM_SpaceException FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

void Unpop ( )

This method adds the data removed in the previous pop method and removes the lock.

Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

void Erase ( )

This method deletes an element in the FAM.

Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

String ToString ( )

This method returns a descriptive string containing the space, key, timeout, maximum retries, and session data.

string	descriptive string