local interface Evictor
extends
::Ice::ServantLocator |
An automatic Ice object persistence manager, based on the evictor pattern. The evictor is a servant locator implementation that stores the persistent state of its objects in a database. Any number of objects can be registered with an evictor, but only a configurable number of servants are active at a time. These active servants reside in a queue; the least recently used servant in the queue is the first to be evicted when a new servant is activated.
Add a servant to this evictor.
Like add, but with a facet.
Add or update a servant.
Permanently destroy an Ice object.
Get an iterator for the identities managed by the evictor.
Get the size of the evictor's servant queue.
Like hasObject, but with a facet.
Returns true if the given identity is managed by the evictor with the default facet.
Lock this object in the evictor cache.
Like keep, but with a facet.
Release a "lock" acquired by keep.
Like release, but with a facet.
Permanently destroy an Ice object.
Like remove, but with a facet.
Set the size of the evictor's servant queue.
Object* add(Object servant, ::Ice::Identity id); |
Add a servant to this evictor. The state of the servant passed to this operation will be saved in the evictor's persistent store.
The servant to add.
The identity of the Ice object that is implemented by the servant.
Raised if the evictor already has an object with this identity.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
Object* addFacet(Object servant, ::Ice::Identity id, string facet); |
Like add, but with a facet. Calling add(servant, id) is equivalent to calling addFacet with an empty facet.
The servant to add.
The identity of the Ice object that is implemented by the servant.
The facet. An empty facet means the default facet.
Raised if the evictor already has an object with this identity.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
void createObject(::Ice::Identity id, Object servant); |
Add or update a servant. The state of the servant passed to this operation will be saved in the evictor's persistent store. This operation is deprecated and will be removed in a future release. It is recommended to use add instead.
The identity of the Ice object that is implemented by the servant.
The servant to add.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
void destroyObject(::Ice::Identity id); |
Permanently destroy an Ice object. Like remove, except destroyObject does not raise any exception when the object does not exist. This operation is deprecated and will be removed in a future release. It is recommended to use remove instead.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
EvictorIterator getIterator(string facet, int batchSize); |
Get an iterator for the identities managed by the evictor.
The facet. An empty facet means the default facet.
Internally, the Iterator retrieves the identities in batches of size batchSize. Selecting a small batchSize can have an adverse effect on performance.
Raised if a the evictor has been deactivated.
int getSize(); |
Get the size of the evictor's servant queue.
Raised if a the evictor has been deactivated.
bool hasFacet(::Ice::Identity id, string facet); |
Like hasObject, but with a facet. Calling hasObject(id) is equivalent to calling hasFacet with an empty facet.
Raised if a database failure occurred.
Raised if a the evictor has been deactivated.
bool hasObject(::Ice::Identity id); |
Returns true if the given identity is managed by the evictor with the default facet.
Raised if a database failure occurred.
Raised if a the evictor has been deactivated.
void keep(::Ice::Identity id); |
Lock this object in the evictor cache. This lock can be released by release or remove. release releases only one lock, while remove releases all the locks.
Raised if this identity was not registered with the evictor.
Raised if a database failure occurred.
void keepFacet(::Ice::Identity id, string facet); |
Like keep, but with a facet. Calling keep(id) is equivalent to calling keepFacet with an empty facet.
The identity of the Ice object.
The facet. An empty facet means the default facet.
Raised if this identity was not registered with the evictor.
Raised if a database failure occurred.
void release(::Ice::Identity id); |
Release a "lock" acquired by keep. Once all the locks on an object have been released, the object is again subject to the normal eviction strategy.
void releaseFacet(::Ice::Identity id, string facet); |
Like release, but with a facet. Calling release(id) is equivalent to calling releaseFacet with an empty facet.
The identity of the Ice object.
The facet. An empty facet means the default facet.
Object remove(::Ice::Identity id); |
Permanently destroy an Ice object.
Raised if this identity was not registered with the evictor.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
Object removeFacet(::Ice::Identity id, string facet); |
Like remove, but with a facet. Calling remove(id) is equivalent to calling removeFacet with an empty facet.
The identity of the Ice object.
The facet. An empty facet means the default facet.
Raised if this identity was not registered with the evictor.
Raised if a database failure occurred.
Raised if the evictor has been deactivated.
void setSize(int sz); |
Set the size of the evictor's servant queue. This is the maximum number of servants the evictor keeps active. Requests to set the queue size to a value smaller than zero are ignored.
The size of the servant queue. If the evictor currently holds more than setSize servants in its queue, it evicts enough servants to match the new size. Note that this operation can block if the new queue size is smaller than the current number of servants that are servicing requests. In this case, the operation waits until a sufficient number of servants complete their requests.
Raised if a the evictor has been deactivated.
| <<< Previous | Home | Next >>> |
| Freeze::DeadlockException | Up | Freeze::EvictorDeactivatedException |