A background-save evictor is an evictor that saves updates asynchronously in a background thread. More...
defined in <Freeze/BackgroundSaveEvictor.ice>
local interface BackgroundSaveEvictor extends Freeze::Evictor { ... }
Operations | |
| void | keep (Ice::Identity id) |
| Lock this object in the evictor cache. More... | |
| void | keepFacet (Ice::Identity id, string facet) |
| Like keep, but with a facet. More... | |
| void | release (Ice::Identity id) |
| Release a lock acquired by keep. More... | |
| void | releaseFacet (Ice::Identity id, string facet) |
| Like release, but with a facet. More... | |
 Operations inherited from Freeze::Evictor | |
| Object * | add (Object servant, Ice::Identity id) |
| Add a servant to this evictor. More... | |
| Object * | addFacet (Object servant, Ice::Identity id, string facet) |
| Like add, but with a facet. More... | |
| EvictorIterator | getIterator (string facet, int batchSize) |
| Get an iterator for the identities managed by the evictor. More... | |
| int | getSize () |
| Get the size of the evictor's servant queue. More... | |
| bool | hasFacet (Ice::Identity id, string facet) |
| Like hasObject, but with a facet. More... | |
| bool | hasObject (Ice::Identity id) |
| Returns true if the given identity is managed by the evictor with the default facet. More... | |
| Object | remove (Ice::Identity id) |
| Permanently destroy an Ice object. More... | |
| Object | removeFacet (Ice::Identity id, string facet) |
| Like remove, but with a facet. More... | |
| void | setSize (int sz) |
| Set the size of the evictor's servant queue. More... | |
| Operations inherited from Ice::ServantLocator | |
| void | deactivate (string category) |
| void | finished (Current curr,["swift:nonnull"] Object servant, LocalObject cookie) |
| Object | locate (Current curr, out LocalObject cookie) |
Detailed Description
A background-save evictor is an evictor that saves updates asynchronously in a background thread.
Operation Documentation
◆ keep()
| 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.
- Parameters
-
id The identity of the Ice object.
- Exceptions
-
Ice.NotRegisteredException Raised if this identity was not registered with the evictor. DatabaseException Raised if a database failure occurred.
◆ keepFacet()
| 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.
- Parameters
-
id The identity of the Ice object. facet The facet. An empty facet means the default facet.
- Exceptions
-
Ice.NotRegisteredException Raised if this identity was not registered with the evictor. DatabaseException Raised if a database failure occurred.
- See also
- keep
- releaseFacet
- removeFacet
◆ release()
| 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.
- Parameters
-
id The identity of the Ice object.
- Exceptions
-
Ice.NotRegisteredException Raised if this object was not locked with keep or keepFacet.
◆ releaseFacet()
| 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.
- Parameters
-
id The identity of the Ice object. facet The facet. An empty facet means the default facet.
- Exceptions
-
Ice.NotRegisteredException Raised if this object was not locked with keep or keepFacet.
- See also
- keep
- releaseFacet
The documentation for this interface was generated from the following file:
- Freeze/BackgroundSaveEvictor.ice
