tibasSpace_PutEx()

Stores a tuple into the space and returns the corresponding tuple, and allows you to specify a lock wait value, lock or unlock value, and a forget value.

Declaration

tibas_status tibasSpace_PutEx(
    tibasSpace      space,
    tibasTuple*     oldValue,
    tibasTuple      newValue,
    tibasPutOptions options)

Parameters

Parameter Description
space The TIBCO ActiveSpaces entity on which the function is invoked.
oldValue A tuple containing the old value of the tuple.
newValue The tuple containing key fields, which specifies the new value.
options Provide a tibasPutOptions structure that specifies the options for the put.

Remarks

Use the tibasSpace_PutEx() function to store a tuple into a space and return the original value of the tuple, if it has a value. The function also allows you to specify a lock wait value, lock or unlock value, and a forget value.

The options parameter specifies a tibasPutOptions structure that specifies options for the put. The tibasPutOptions structure is defined as follows:

struct _tibasPutOptions {
    tibas_long    entryTTL;
    tibas_long    lockWait;
    tibas_boolean lock;
    tibas_boolean unlock;
    tibas_boolean forget;
};

The put options are defined as follows:

entryTTL
Allows you to define the entry TTL for the tuple that is being put.
lockWait
Specifies a lock wait time, in milliseconds.
lock
Put 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_Put(), tibasSpace_PutAll(), tibasSpace_CompareAndPutAllEx(), tibasSpace_CompareAndPut(), tibasSpace_CompareAndPutEx(), tibasSpace_CompareAndPutAll(), tibasSpace_CompareAndPutAllEx()