• Webinars
  • Docs
  • Download
  • Blogs
  • Contact Us
Try Free
Show / Hide Table of Contents

Namespace Alachisoft.NCache.Client

Classes

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. In scenarios where multiple attributes have to be set while adding an item in cache using CacheItem is preferred.Using CacheItem class object removes the problem of using multiple API overloads on adding/updating data in cache.You can easily use the basic API overload and add/update data easily using CacheItem.

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

Class to hold Object query and values, intended for notifications.

CQEventArg

This object is received when an even 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.

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.

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 OQ 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

Enumeration that defines the tag search options.

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.

Back to top Copyright © 2017 Alachisoft