IPileImplementation MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The IPileImplementation type exposes the following members.
Methods

  NameDescription
Public methodCheckForCompleteStop
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from IService.)
Public methodCompact
Tries to delete extra capacity which is allocated but not currently needed. Returns the number of bytes freed back to the system
(Inherited from IPile.)
Public methodConfigure
Configures an entity from supplied config node
(Inherited from IConfigurable.)
Public methodDelete
Deletes object from pile by its pointer returning true if there is no access violation and pointer is pointing to the valid object, throws otherwise unless throwInvalid is set to false
(Inherited from IPile.)
Public methodOnlineDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from OnlineIDisposable.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from IExternallyParameterized.)
Public methodExternalParametersForGroups
Gets names of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.)
Public methodExternalSetParameter
Sets external parameter value, true if parameter name was found and set succeeded
(Inherited from IExternallyParameterized.)
Public methodGet
Returns a CLR object by its pointer or throws access violation if pointer is invalid
(Inherited from IPile.)
Public methodGetRawBuffer
Returns a raw byte[] occupied by the object payload, only payload is returned along with serializer flag which tells what kind of serializer was used. This method is rarely used, it is needed for debugging and special-case "direct" memory access on read to bypass the de-serialization process altogether
(Inherited from IPile.)
Public methodPurge
Deletes all objects freeing all segment memory buffers. This method may require the caller to have special rights
(Inherited from IPile.)
Public methodPut
Puts a CLR object into the pile and returns a newly-allocated pointer. Throws out-of-space if there is not enough space in the pile and limits are set. Optional lifeSpanSec will auto-delete object after the interval elapses if the pile SupportsObjectExpiration and SweepExpireObjects is set to true
(Inherited from IPile.)
Public methodRejuvenate
If pile supports expiration, resets object age to zero. Returns true if object was found and reset. N/A for pile that do not support expiration
(Inherited from IPile.)
Public methodSignalStop
Non-blocking call that initiates the stopping of the service
(Inherited from IService.)
Public methodSizeOf
Returns the size of pointed-to object in bytes or throws access violation if pointer is invalid. The serialized object size is returned, not the CLR object size.
(Inherited from IPile.)
Public methodStart
Blocking call that starts the service instance
(Inherited from IService.)
Public methodWaitForCompleteStop
Blocks execution of current thread until this service has completely stopped
(Inherited from IService.)
Back to Top
Properties

  NameDescription
Public propertyAllocatedMemoryBytes
Returns the number of bytes allocated by this pile from system memory
(Inherited from IPileStatus.)
Public propertyAllocMode
Defines modes of allocation: space/time tradeoff
Public propertyComponentCommonName
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations. This name is searched-by some management tools that allow to find component by this name that does not change between application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from IApplicationComponent.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from IApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from IApplicationComponent.)
Public propertyExternalParameters
Gets names/types of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.)
Public propertyInstrumentationEnabled
Turns on/off instrumentation
(Inherited from IInstrumentable.)
Public propertyLocality
Returns whether pile is local or distributed
(Inherited from IPileStatus.)
Public propertyMaxMemoryLimit
Imposes a limit on maximum number of bytes that a pile can allocate of the system heap. The default value of 0 means no limit, meaning - the pile will keep allocating objects until the system allows
Public propertyMaxSegmentLimit
Gets the maximum count of segments that this pile can have. The property is not thread-safe for set and can only be set if pile is inactive. The value of zero means no limit
Public propertyMemoryCapacityBytes
Returns an approximate capacity of free memory that the system has left
(Inherited from IPileStatus.)
Public propertyName (Inherited from INamed.)
Public propertyNodeCount
Returns the number of nodes(servers) that service this distributed pile. If this pile locality is local then returns 1
(Inherited from IPileStatus.)
Public propertyObjectCount
Returns the number of allocated objects in this pile
(Inherited from IPileStatus.)
Public propertyOverheadBytes
Returns the number of extra bytes used by pile metadata currently occupied by object stored in this pile
(Inherited from IPileStatus.)
Public propertyPersistence
Returns the model of object persistence that this pile supports
(Inherited from IPileStatus.)
Public propertyRunning
Returns true when service is active or about to become active. Check in service implementation loops/threads/tasks
(Inherited from IService.)
Public propertySegmentCount
Returns the number of segments allocated
(Inherited from IPileStatus.)
Public propertySegmentSize
Gets the segment size in bytes, up to (2^31)-1 The property is not thread-safe for set and can only be set if pile is inactive
Public propertyStatus
Current service status
(Inherited from IService.)
Public propertySupportsObjectExpiration
Returns whether this instance supports object expiration
(Inherited from IPileStatus.)
Public propertySweepExpiredObjects
Control whether the instance respects object life spans if they are set
Public propertyUtilizedBytes
Returns the number of bytes allocated for object storage within AllocatedMemoryBytes
(Inherited from IPileStatus.)
Back to Top
See Also