Search Results for

Show / Hide Table of Contents

# Class DataStreamerClientOptions

Thin client data streamer options.

To set a receiver, use generic class DataStreamerClientOptions<TK, TV>.

See also IDataStreamerClient<TK, TV>, GetDataStreamer<TK, TV>(String).

##### Inheritance

System.Object
DataStreamerClientOptions
DataStreamerClientOptions<TK, TV>

###### Namespace: Apache.Ignite.Core.Client.Datastream

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

##### Syntax

    public class DataStreamerClientOptions : object

### Constructors

#### DataStreamerClientOptions()

Initializes a new instance of DataStreamerClientOptions.

##### Declaration

    public DataStreamerClientOptions()

#### DataStreamerClientOptions(DataStreamerClientOptions)

Initializes a new instance of DataStreamerClientOptions.

##### Declaration

    public DataStreamerClientOptions(DataStreamerClientOptions options)

##### Parameters

Type | Name | Description
--- | --- | ---
DataStreamerClientOptions | options | Options to copy from.

### Fields

#### DefaultPerNodeBufferSize

The default client-side per-node buffer size (cache entries count), see PerNodeBufferSize.

##### Declaration

    public const int DefaultPerNodeBufferSize = null

##### Field Value

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

#### DefaultPerNodeParallelOperations

The default limit for parallel operations per server node connection, see PerNodeParallelOperations.

Calculated as times 4.

##### Declaration

    public static readonly int DefaultPerNodeParallelOperations

##### Field Value

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

### Properties

#### AllowOverwrite

Gets or sets a value indicating whether existing values can be overwritten by the data streamer. Performance is better when this flag is false.

NOTE: When false, cache updates won't be propagated to cache store (even if SkipStore is false).

Default is `false`.

##### Declaration

    public bool AllowOverwrite { get; set; }

##### Property Value

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

#### AutoFlushInterval

Gets or sets the automatic flush interval. Data streamer buffers the data for performance reasons. The buffer is flushed in the following cases:

- Buffer is full.
- Flush() is called.
- Periodically when AutoFlushInterval is set.

When set to , automatic flush is disabled.

Default is (disabled).

##### Declaration

    public TimeSpan AutoFlushInterval { get; set; }

##### Property Value

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

#### PerNodeBufferSize

Gets or sets the size (entry count) of per node buffer.

Default is DefaultPerNodeBufferSize.

##### Declaration

    public int PerNodeBufferSize { get; set; }

##### Property Value

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

#### PerNodeParallelOperations

Gets or sets the limit for parallel operations per server node.

Default is DefaultPerNodeParallelOperations.

##### Declaration

    public int PerNodeParallelOperations { get; set; }

##### Property Value

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

#### ReceiverKeepBinary

Gets or sets a value indicating whether Receiver should operate in binary mode.

##### Declaration

    public bool ReceiverKeepBinary { get; set; }

##### Property Value

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

#### SkipStore

Gets or sets a flag indicating that write-through behavior should be disabled for data loading.

AllowOverwrite must be true for write-through to work.

Default is `false`.

##### Declaration

    public bool SkipStore { get; set; }

##### Property Value

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