Locks the entry stored in the Space which has the key specified in the given Tuple

Namespace: Com.Tibco.As.Space
Assembly: TIBCO.ActiveSpaces.Common (in TIBCO.ActiveSpaces.Common.dll) Version: 2.0.0.0 (2.2.0.015)

Syntax

C#
Tuple Lock(
	Tuple tuple,
	LockOptions lockOpts
)
Visual Basic
Function Lock ( 
	tuple As Tuple,
	lockOpts As LockOptions
) As Tuple
Visual C++
Tuple^ Lock(
	Tuple^ tuple, 
	LockOptions^ lockOpts
)
F#
abstract Lock : 
        tuple : Tuple * 
        lockOpts : LockOptions -> Tuple

Parameters

tuple
Type: Com.Tibco.As.Space..::..Tuple
Tuple containing the key of the entry to lock
lockOpts
Type: Com.Tibco.As.Space..::..LockOptions
Used to specify the following:
  • lock wait: amount of time to wait for any lock, blocking the operation, to clear (default setting taken from SpaceDef.getLockWait())
  • forget: whether to return the data of the locked entry (true=do not return the data, default=false)
  • result handler: called, if specified, when the lock operation is complete
  • closure: used to pass data to the result handler

Return Value

Type: Tuple
Tuple if the entry has any values associated with it, null otherwise

See Also