Namespace Alachisoft.NCache.Client
Classes
BuiltInAggregator
Sets current Built in aggregator instance. Performs actual grouping and analytical operations on data. IAggregator can perform following operations Average, Sum, Min, Max, Count and Distinct.
BuiltInAggregator.BigIntegerAggregator
Implements built in BigInteger type aggregator.
BuiltInAggregator.CountAggregator
Implements built in Count aggregator.
BuiltInAggregator.DateAggregator
Implements built in Date type aggregator.
BuiltInAggregator.DecimalAggregator
Implements built in Decimal type aggregator.
BuiltInAggregator.DistinctAggregator
Implements built in Distinct aggregator i.e gives unique occurrence of item in data set.
BuiltInAggregator.DoubleAggregator
Implements built in Double type aggregator.
BuiltInAggregator.FloatAggregator
Implements built in Float type aggregator.
BuiltInAggregator.IntegerAggregator
Implements built in Integer type aggregator.
BuiltInAggregator.LongAggregator
Implements built in LongInteger type aggregator.
BuiltInAggregator.ShortAggregator
Implements built in ShortInteger type aggregator.
BuiltInAggregator.StringAggregator
Implements built in String type aggregator.
CacheCollection
Represents a collection of the caches initialized within the same application domain.
CacheConnection
Instance of this class can be used to define the parameters to establish connection with cache.
CacheConnectionOptions
Instance of this class can be used to define the parameters at the time of client connection with the cache.
CacheEventArg
This object is received when an event is raised and delegate CacheDataNotificationCallback is executed CacheEventArg contains necessary information to identify the event and perform necessary actions accordingly. It inherits EventArg which is also a parent of CQEventArg This class is consistent for both selective and general events
CacheEventDescriptor
Instance of this class holds the link to the registered delegate Keep it safe and use it to unregister the registered delegate when required. The bool IsRegistered returns false when the descriptor has been consumed to unregister the delegate. Then this instance can then be disposed of. Upon re-registering for the interested event, a new descriptor will be created.
CacheItem
NCache uses a "key" and "value" structure for storing objects in cache. When an object is added in cache it is stored as value and metadata against the specified key. This combination of value and metadata is defined as CacheItem in NCache. The value of the objects stored in the cache can range from being simple string types to complex objects.
CacheItem class in NCache has properties that enable you to set metadata for the item to be added in cache in an organized way.
CacheItemVersion
Represents the version of each cache item. An instance of this class is used in the optimistic concurrency model to ensure the data integrity.
CacheManager
Provides and manages the instance of ICache
CacheStream
CacheStream is derived from System.IO.Stream. It is designed to put/fetch BLOB using standard Stream interface.
CacheStreamAttributes
CacheStreamAttributes Class contains information about the CacheStream attributes.
CacheSyncDependency
A client application can have more than one cache instances initialized. CacheSyncDependency keeps the items present in one cache synchronized with the items present in another cache.
ContinuousQuery
Intended for runtime monitoring and sharing of data related to an observable data set. This allows applications to be notified of all changes that occur within the queried result set in the cache.
CQEventArg
This object is received when an event is raised and delegate QueryDataNotificationCallback is executed CQEventArg contains necessary information to identify the event and perform necessary actions accordingly. It inherits EventArg which is also a parent of CacheEventArg
Credentials
Class that provides the security parameters for authorization.
EventArg
Parent of CQEventArg and CacheEventArg Contains the necessary information related to the event being raised
EventCacheItem
This is a stripped down version of CacheItem Contains basic information of an item present in the cache Will be provided in QueryDataNotificationCallback or Alachisoft.NCache.Client.CacheItemRemovedCallback but only when the event is registered against Metadata or DataWithMetadata
LockHandle
An instance of this class is used to lock and unlock the cache items in pessimistic concurrency model.
NCacheErrorCodes
Contains all types of error codes used by NCache.
NodeInfo
Holds the information about the cluster member nodes. It identifies each member of the cluster uniquely with a combination of the IP Address and port. An instance of this class can not be instantiated. When client applications register the events MemberJoinedCallback or MemberLeftCallback, an instance of NodeInfo is passed in the notification.
QueryCommand
Class to hold query text and values.
RemoteCacheKeyDependency
This class alows to form key based dependency in a remote cache.
ServerInfo
Provide connection information for the client to the server node in cache.
Interfaces
ICache
This interface contians the services and methods that are used to perform operations on the cache.
ICacheReader
Reads one or more than forward-only stream of result sets by executing SQL Query commands on cache source.
Enums
CacheItemRemovedReason
Specifies the reason an item was removed from the ICache.
ClientCacheSyncMode
Gets/Sets Enumeration to specify how the Client cache is synchronized with the cluster caches through events.
IsolationLevel
Specifies the Isolation level of the ICache.
LogLevel
Defines the level of logging you want to use.
StreamMode
Specifies the modes of CacheStream.
TagSearchOptions
Specifies the search options of tag in cache.
Delegates
CacheClearedCallback
Defines a callback method for notifying applications when the ICache is cleared.
CacheDataNotificationCallback
Defines a callback method for notifying applications when an item is updated in the Alachisoft.NCache.Client.Cache.
CacheStoppedCallback
Defines a callback method for notifying applications when the Alachisoft.NCache.Client.Cache is stopped.
ContinuousQueryClearCallback
Defines a callback method for notifying application when Continuous Query result set is cleared.
MemberJoinedCallback
Defines a callback method for notifying applications when a new node joins the cluster.
MemberLeftCallback
Defines a callback method for notifying applications when a node leaves the cluster.
QueryDataNotificationCallback
Defines a callback method for notifying application when an item is added, updated or removed from the Continuous Query result.