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.
setSize — Set the size of the evictor's servant queue.
getSize — Get the size of the evictor's servant queue.
add — Add a servant to this evictor.
addFacet — Like add, but with a facet.
remove — Permanently destroy an Ice object.
removeFacet — Like remove, but with a facet.
hasObject — Returns true if the given identity is managed by the evictor with the default facet.
hasFacet — Like hasObject, but with a facet.
getIterator — Get an iterator for the identities managed by the evictor.
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.
sz
— The size of the servant queue. If the evictor currently holds more than sz
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.
Freeze::EvictorDeactivatedException — Raised if a the evictor has been deactivated.
Get the size of the evictor's servant queue.
The size of the servant queue.
Freeze::EvictorDeactivatedException — Raised if a the evictor has been deactivated.
Add a servant to this evictor. The state of the servant passed to this operation will be saved in the evictor's persistent store.
servant
— The servant to add.
id
— The identity of the Ice object that is implemented by the servant.
A proxy that matches the given identity and this evictor's object adapter.
Ice::AlreadyRegisteredException — Raised if the evictor already has an object with this identity.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if the evictor has been deactivated.
Like add, but with a facet. Calling add(servant, id)
is equivalent to calling addFacet with an empty facet.
servant
— The servant to add.
id
— The identity of the Ice object that is implemented by the servant.
facet
— The facet. An empty facet means the default facet.
A proxy that matches the given identity and this evictor's object adapter.
Ice::AlreadyRegisteredException — Raised if the evictor already has an object with this identity.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if the evictor has been deactivated.
Permanently destroy an Ice object.
id
— The identity of the Ice object.
The removed servant.
Ice::NotRegisteredException — Raised if this identity was not registered with the evictor.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if the evictor has been deactivated.
Like remove, but with a facet. Calling remove(id)
is equivalent to calling removeFacet with an empty facet.
id
— The identity of the Ice object.
facet
— The facet. An empty facet means the default facet.
The removed servant.
Ice::NotRegisteredException — Raised if this identity was not registered with the evictor.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if the evictor has been deactivated.
Returns true if the given identity is managed by the evictor with the default facet.
true if the identity is managed by the evictor, false otherwise.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if a the evictor has been deactivated.
Like hasObject, but with a facet. Calling hasObject(id)
is equivalent to calling hasFacet with an empty facet.
true if the identity is managed by the evictor for the given facet, false otherwise.
Freeze::DatabaseException — Raised if a database failure occurred.
Freeze::EvictorDeactivatedException — Raised if a the evictor has been deactivated.
Get an iterator for the identities managed by the evictor.
facet
— The facet. An empty facet means the default facet.
batchSize
— Internally, the Iterator retrieves the identities in batches of size batchSize. Selecting a small batchSize can have an adverse effect on performance.
A new iterator.
Freeze::EvictorDeactivatedException — Raised if a the evictor has been deactivated.