TIBCO FTL®

Public Member Functions | List of all members
TIBCO.FTL.ITibLock Interface Reference

Cooperating application programs can use locks to implement exclusive access to a map within a persistence store. More...

Inheritance diagram for TIBCO.FTL.ITibLock:

## Public Member Functions
bool | Request ()
| No operation. More...
void | ReturnLock ()
| Release a lock. More...
void | Steal ()
| Forcibly acquire a lock, even if another process holds it. More...

## Detailed Description

Cooperating application programs can use locks to implement exclusive access to a map within a persistence store.

To create a lock object, see IRealm.CreateLock.

If a client process exits or disconnects from the persistence server, the library automatically releases all the locks that the process holds.

This file defines the calls that manipulate locks. In addition, map objects and map iterator objects have methods that operate while holding a lock.

Customers do not implement this interface.

## Member Function Documentation

## ◆ Request()

bool TIBCO.FTL.ITibLock.Request | ( |  | ) |

No operation.

In releases earlier than 5.0, this call requested a lock from its persistence store.

In Release 5.0 and later, this call is no longer necessary; it returns `true` without any other effect.

Calls that require a lock automatically request it; see:

- ITibMap.Set(string, IMessage, ITibLock)
- ITibMap.Get(string, ITibLock)
- ITibMap.Remove(string, ITibLock)
- ITibMap.CreateIterator(ITibLock, ITibProperties)

Programs that correctly used earlier versions of lock calls continue to operate properly.

Returns
  This call returns the boolean value `true`.

## ◆ ReturnLock()

void TIBCO.FTL.ITibLock.ReturnLock | ( |  | ) |

Release a lock.

If the process does not hold the lock, this call has no effect.

## ◆ Steal()

void TIBCO.FTL.ITibLock.Steal | ( |  | ) |

Forcibly acquire a lock, even if another process holds it.