Search Results for

Show / Hide Table of Contents

# Class ContinuousQueryClient<TK, TV>

API for configuring continuous cache queries in thin client.

Continuous queries allow to register a remote filter and a listener for cache update events. If an update event passes the filter, it will be sent to the client.

To execute the query use method QueryContinuous(ContinuousQueryClient<TK, TV>).

##### Inheritance

System.Object
ContinuousQueryClient
ContinuousQueryClient<TK, TV>

##### Inherited Members

ContinuousQueryClient.DefaultBufferSize

###### Namespace: Apache.Ignite.Core.Client.Cache.Query.Continuous

###### Assembly: Apache.Ignite.Core.dll

##### Syntax

    public class ContinuousQueryClient<TK, TV> : ContinuousQueryClient

##### Type Parameters

Name | Description
--- | ---
TK |
TV |

### Constructors

#### ContinuousQueryClient()

Initializes a new instance of ContinuousQueryClient<TK, TV> class.

##### Declaration

    public ContinuousQueryClient()

#### ContinuousQueryClient(ICacheEntryEventListener<TK, TV>)

Initializes a new instance of ContinuousQueryClient<TK, TV> class with a specified listener.

##### Declaration

    public ContinuousQueryClient(ICacheEntryEventListener<TK, TV> listener)

##### Parameters

Type | Name | Description
--- | --- | ---
ICacheEntryEventListener<TK, TV> | listener |

### Properties

#### BufferSize

Buffer size. When a cache update happens, entry is first put into a buffer. Entries from buffer will be sent to the master node only if the buffer is full or time provided via TimeInterval is exceeded.

Defaults to DefaultBufferSize

##### Declaration

    public int BufferSize { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

#### Filter

Optional cache entry filter. Invoked on a node where cache event occurred. If the filter returns `false`, then cache entry event will not be sent to a node where the continuous query has been started.

This filter will be serialized and sent to the server nodes. .NET filters require all server nodes to be .NET-based. Java filters can be used with JavaObject and ToCacheEntryEventFilter<TK, TV>(JavaObject).

##### Declaration

    public ICacheEntryEventFilter<TK, TV> Filter { get; set; }

##### Property Value

Type | Description
--- | ---
ICacheEntryEventFilter<TK, TV> |

#### IncludeExpired

Gets or sets a value indicating whether to notify about Expired events.

If `true`, then the remote listener will get notifications about expired cache entries. Otherwise, only Created, Updated, and Removed events will be passed to the listener.

Defaults to `false`.

##### Declaration

    public bool IncludeExpired { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

#### Listener

Cache entry event listener. Invoked locally.

##### Declaration

    public ICacheEntryEventListener<TK, TV> Listener { get; set; }

##### Property Value

Type | Description
--- | ---
ICacheEntryEventListener<TK, TV> |

#### TimeInterval

Time interval. When a cache update happens, entry is first put into a buffer. Entries from buffer will be sent to the master node only if the buffer is full (its size can be provided via BufferSize property) or time provided via this method is exceeded.

Defaults to `0` which means that time check is disabled and entries will be sent only when buffer is full.

##### Declaration

    public TimeSpan TimeInterval { get; set; }

##### Property Value

Type | Description
--- | ---
TimeSpan |