Dashboard > Appistry EAF v3.8 > ... > Java FAM API > FAM_Queue.java
Log In   View a printable version of the current page.  
  FAM_Queue.java

Package: com.appistry.fam

Class FAM_Queue<T>

FAM_Queue

FAM_Queue<T>(String space,
             String key,
             FAM_Session session)

The constructor for the queue object.

string space identifier}
string key
FAM_Session session identifier
Exceptions NullPointerException

push

void push(T value)

This function adds data to the end of a queue.

T data to push

pop

T pop( )

This function returns data from the FAM and places a lock on the FAM.

T data returned the FAM; NULL if timed out

unpop

void unpop( )

This function adds the data that was removed in the previous pop function and removes the lock.

setTimeout

void setTimeout(int timeout)

This function sets the amount of time the client waits for a FAM operation to this FAM space to complete.

int maximum amount of time, in milliseconds, the client waits for a FAM operation to complete

getTimeout

int getTimeout( )

This function returns the amount of time the client waits for a FAM operation to this FAM space to complete.

int maximum amount of time, in milliseconds, the client waits for a FAM operation to complete

setMaxRetries

void setMaxRetries(int maxRetries)

This function sets the maximum number of times the FAM space will retry a FAM operation.

int maximum number of times the FAM will retry a FAM operation

getMaxRetries

int getMaxRetries( )

This function returns the maximum number of times the FAM space will retry a FAM operation.

int maximum number of times the FAM will retry a FAM operation

getSpace

String getSpace( )

This function returns the space name.

string space name

getKey

String getKey( )

This function returns the key.

string key

toString

String toString( )

This function returns a string representation of the object.

string string