Table of Contents

Class KNetShareConsumer<K, V, TJVMK, TJVMV>

Namespace
MASES.KNet.Consumer
Assembly
MASES.KNet.dll

KNet extension of KafkaConsumer<K, V>

public class KNetShareConsumer<K, V, TJVMK, TJVMV> : KafkaShareConsumer<TJVMK, TJVMV>, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition, IShareConsumer<K, V, TJVMK, TJVMV>, IShareConsumer<TJVMK, TJVMV>, ICloseable, IAutoCloseable

Type Parameters

K

The key type

V

The value type

TJVMK

The JVM type of K

TJVMV

The JVM type of V

Inheritance
ShareConsumer<TJVMK, TJVMV>
KafkaShareConsumer<TJVMK, TJVMV>
KNetShareConsumer<K, V, TJVMK, TJVMV>
Implements
IShareConsumer<K, V, TJVMK, TJVMV>
IShareConsumer<TJVMK, TJVMV>
Derived
Inherited Members

Constructors

KNetShareConsumer(ConsumerConfigBuilder, ISerDes<K, TJVMK>, ISerDes<V, TJVMV>, bool)

Initialize a new instance of KNetShareConsumer<K, V, TJVMK, TJVMV>

public KNetShareConsumer(ConsumerConfigBuilder props, ISerDes<K, TJVMK> keyDeserializer, ISerDes<V, TJVMV> valueDeserializer, bool useJVMCallback = false)

Parameters

props ConsumerConfigBuilder

The properties to use, see ConsumerConfigBuilder

keyDeserializer ISerDes<K, TJVMK>

Key serializer base on SerDes<T, TJVMT>

valueDeserializer ISerDes<V, TJVMV>

Value serializer base on SerDes<T, TJVMT>

useJVMCallback bool

true to active callback based mode

KNetShareConsumer(ConsumerConfigBuilder, bool)

Initialize a new instance of KNetShareConsumer<K, V, TJVMK, TJVMV>

public KNetShareConsumer(ConsumerConfigBuilder configBuilder, bool useJVMCallback = false)

Parameters

configBuilder ConsumerConfigBuilder

An instance of ConsumerConfigBuilder

useJVMCallback bool

true to active callback based mode

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

IsCompleting

true if the IShareConsumer<K, V, TJVMK, TJVMV> instance is completing async operation

public bool IsCompleting { get; }

Property Value

bool

IsEmpty

true if the IShareConsumer<K, V, TJVMK, TJVMV> instance has an empty set of items in async operation

public bool IsEmpty { get; }

Property Value

bool

WaitingBatches

Number of message batches in the IConsumer<K, V, TJVMK, TJVMV> instance waiting to be processed in async operation

public int WaitingBatches { get; }

Property Value

int

WaitingMessages

Number of messages in the IConsumer<K, V, TJVMK, TJVMV> instance waiting to be processed in async operation

public int WaitingMessages { get; }

Property Value

int

Methods

Consume(long, Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool>)

KNet sync extension for Poll(Duration)

public void Consume(long timeoutMs, Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool> callback)

Parameters

timeoutMs long

Timeout in milliseconds

callback Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool>

The Func<T, TResult> where receives ConsumerRecord<K, V, TJVMK, TJVMV>; return true from callback to dispose the object

ConsumeAsync(long)

KNet async extension for Poll(Duration)

public bool ConsumeAsync(long timeoutMs)

Parameters

timeoutMs long

Timeout in milliseconds

Returns

bool

true if something was enqued for Async operations

Dispose(bool)

Implements the pattern described in https://learn.microsoft.com/en-en/dotnet/standard/garbage-collection/implementing-dispose

protected override void Dispose(bool disposing)

Parameters

disposing bool

The disposing parameter is a bool that indicates whether the method call comes from a Dispose() method (its value is true) or from a finalizer (its value is false)

Poll(TimeSpan)

KNet extension for Poll(Duration)

public ConsumerRecords<K, V, TJVMK, TJVMV> Poll(TimeSpan timeout)

Parameters

timeout TimeSpan

Timeout expressed as TimeSpan

Returns

ConsumerRecords<K, V, TJVMK, TJVMV>

ConsumerRecords<K, V, TJVMK, TJVMV>

SetCallback(Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool>, Action<Exception>)

Sets the Func<T, TResult> to use to receive the ConsumerRecord<K, V, TJVMK, TJVMV>

public void SetCallback(Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool> cb, Action<Exception> exceptionCallback = null)

Parameters

cb Func<ConsumerRecord<K, V, TJVMK, TJVMV>, bool>

The callback Func<T, TResult>

exceptionCallback Action<Exception>

The callback receiving Exception thrown in async operations

Edit this page