tibasSpace_LockEx()

Locks the tuple associated with a key tuple value, and allows you to specify a wait value, a forget value, and a filter.

Declaration

tibas_status tibasSpace_LockEx(
    tibasSpace space,
    tibasTuple* value,
    tibasTuple key,
    tibasLockOptions options)

Parameters

Parameter Description
space The TIBCO ActiveSpaces entity on which the function is invoked.
value Returns either the tuple containing the locked tuple or NULL if no matching tuple can be found in the space.
key A tuple containing key fields.
options Provide a tibasLockpOtions structure that specifies the options for the lock.

Remarks

Use the tibasSpace_LockEx() function to lock the tuple associated with a key tuple value, and also to specify a wait value, a forget value, and a filter.

The options parameter specifies a tibasLockpOtions() structure that specifies the options for the lock. The tibasLockOptions structure is defined as follows: 

struct _tibasLockOptions {
    tibas_long lockWait;
    tibas_boolean forget;
    const char* filter;
};

The lock options are defined as follows:

lockWait
Specifies a lock wait time, in milliseconds.
forget
Specify this option if you want the system to forget the return. This is useful if you do not need the tuple.
filter
Specify a filter string so that the operations are performed only on the data set that matches with the specified filter.

See Also

tibasSpace_Lock(), tibasSpace_LockAll(), tibasSpace_LockAllEx(), tibasSpace_Unlock(), tibasSpace_UnlockAll()