tibasSpace_TakeAllEx()

Batch version of the take operation. Requires a list of key value tuples to take and returns a list of results. Allows you to specify a lock wait value, a lock or unlock value, and a forget value.

Declaration

tibas_status tibasSpace_TakeAllEx(
    tibasSpace space,
    tibasSpaceResultList* resultList,
    tibasTupleList keyList,
    tibasTakeOptions options)

Parameters

Parameter Description
space The TIBCO ActiveSpaces entity on which the function is invoked.
resultList The list of tuples after it is taken from the space and returned.
keyList The list of tuples containing keys for tuples to take.
options Provide a tibasTakeOptions structure that specifies the options for the take.

Remarks

Use the tibasSpace_TakeAllEx() function to take values from a specified list of tuples and return a list of tuples taken from the data store. You can also specify lock, wait, and forget options for the take operation.

The options parameter specifies a tibasTakeOptions structure that specifies the options for the take. The tibasTakeOptions structure is defined as follows:

struct _tibasTakeOptions {
    tibas_long lockWait;
    tibas_boolean lock;
    tibas_boolean unlock;
    tibas_boolean forget;
};

The take options are defined as follows:

lockWait
Specifies a lock wait time, in milliseconds.
lock
Take the data and lock the tuple.
unlock
Unlock the tuple. Only the thread or process that locked the tuple can unlock it.

Lock and unlock are mutually exclusive. If you use one of these, code NULL for the other.

forget
Specify this option if you want the system to forget the return. This is useful if you do not need the tuple.

See Also

tibasSpace_Take(), tibasSpace_TakeAll(), tibasSpace_CompareAndTakeAllEx(), tibasSpace_CompareAndTake(), tibasSpace_CompareAndTakeEx(), tibasSpace_CompareAndTakeAll(), tibasSpace_CompareAndTakeAllEx()