System Template

lock()

Call this method to create/lock a semaphore

See Also

Syntax

string = rb.semaphore.lock(semaphoreName, maxLifeTime, description)

Parameters

The 'lock' method takes 3 parameters:

Results

The 'lock' method returns string:

Remarks

rb.semaphore.lock

This method should be called to request ownership of a specific named semaphore. The parameters to the call are the name (string) of the semaphore that is being requested and a lifetime. The lifetime is the maximum period for which the semaphore is to be held before being automatically released. Generally all semaphores should be explicitly released. This lifetime parameter is used in the situation where the Presentation Page fails to call rb.semaphore.release.

return: If semaphore ownership is granted then this method returns a unique ownership string to the caller. This string must be used in conjuntion with rb.semaphore.release in order to release the semaphore.