Class OffsetCommitCallback

Namespace

Org.Apache.Kafka.Clients.Consumer

Assembly

MASES.KNet.dll

Listener for Kafka OffsetCommitCallback. Extends JVMBridgeListener, implements IOffsetCommitCallback

public class OffsetCommitCallback : JVMBridgeListener, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IOffsetCommitCallback, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition

Inheritance

object

DynamicObject

JVMBridgeBase

JVMBridgeBase<JVMBridgeListener>

JVMBridgeListener

OffsetCommitCallback

Implements

IDynamicMetaObjectProvider

IJVMBridgeCore

IEquatable<IJVMBridgeBaseInstance>

IDisposable

IJVMBridgeBaseStatic

IOffsetCommitCallback

IJVMBridgeBase

IJVMBridgeBaseInstance

IJVMBridgeDefinition

Derived

OffsetCommitCallbackDirect

Remarks

Dispose the object to avoid a resource leak, the object contains a reference to the corresponding JVM object

Constructors

OffsetCommitCallback(IJVMBridgeBaseInitializer)

Initializer used internally by JCOBridge. Do not use directly.

[Obsolete("This public initializer is needed for JCOBridge internal use, other uses can produce unidentifiable behaviors.")]
public OffsetCommitCallback(IJVMBridgeBaseInitializer initializer)

Parameters

initializer IJVMBridgeBaseInitializer

OffsetCommitCallback(params object[])

Generic constructor used by JCOBridge when a derived class needs to forward arguments to the base JVMBridgeBase class.

public OffsetCommitCallback(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnOnComplete

Handler for https://www.javadoc.io/doc/org.apache.kafka/kafka-clients/4.2.1/org/apache/kafka/clients/consumer/OffsetCommitCallback.html#onComplete(java.util.Map,java.lang.Exception)

public Action<Map<TopicPartition, OffsetAndMetadata>, JVMBridgeException> OnOnComplete { get; set; }

Property Value

Action<Map<TopicPartition, OffsetAndMetadata>, JVMBridgeException>

Remarks

Assign a delegate to handle the event without subclassing. If both this handler and a virtual method override are present, the delegate takes precedence. Set to null to delegate to the virtual method.

Methods

InitializeHandlers(Type)

Handlers initializer for OffsetCommitCallback

protected virtual void InitializeHandlers(Type listenerRuntimeType)

Parameters

listenerRuntimeType Type

ListenerShallManageEvent(int)

Invoked from the JVMBridgeListener on each received event to notify the user which can decide to abort the execution for the specific event returning false

protected override bool ListenerShallManageEvent(int eventIndex)

Parameters

eventIndex int

The index of the event triggered as returned from AddEventHandler(string, EventHandler) or AddEventHandler<TDataClass>(string, EventHandler<CLRListenerEventArgs<TDataClass>>)

Returns

bool

Returns true to continue event evaluation, false to return the control to the JVM

Remarks

By default every event continues the execution and reads the data from JVM; this implies an extra cost which can be limited using ListenerShallManageEvent(int) or the ListenerShallManageEventIndex/ListenerShallManageEventName handlers. Returning false the control is immediately returned to the JVM, anyway the user has received the notification. It can be useful in scenarios where the user is interested in few events and the other are simply discarded to optimize the execution speed. By default, this function invokes ListenerShallManageEventIndex, then try ListenerShallManageEventName if they are set or return true

ListenerShallManageEventHandlers(int)

protected virtual bool ListenerShallManageEventHandlers(int eventIndex)

Parameters

eventIndex int

Returns

bool

OnComplete(Map<TopicPartition, OffsetAndMetadata>, JVMBridgeException)

https://www.javadoc.io/doc/org.apache.kafka/kafka-clients/4.2.1/org/apache/kafka/clients/consumer/OffsetCommitCallback.html#onComplete(java.util.Map,java.lang.Exception)

public virtual void OnComplete(Map<TopicPartition, OffsetAndMetadata> arg0, JVMBridgeException arg1)

Parameters

arg0 Map<TopicPartition, OffsetAndMetadata>

Map

arg1 JVMBridgeException

Exception