Table of Contents

Class StateRestoreListener

Namespace
Org.Apache.Kafka.Streams.Processor
Assembly
MASES.KNet.dll

Listener for Kafka StateRestoreListener. Extends JVMBridgeListener, implements IStateRestoreListener

public class StateRestoreListener : JVMBridgeListener, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IStateRestoreListener, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition
Inheritance
StateRestoreListener
Implements
Derived

Remarks

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

Constructors

StateRestoreListener(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 StateRestoreListener(IJVMBridgeBaseInitializer initializer)

Parameters

initializer IJVMBridgeBaseInitializer

StateRestoreListener(params object[])

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

public StateRestoreListener(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnOnBatchRestored

public Action<TopicPartition, String, long, long> OnOnBatchRestored { get; set; }

Property Value

Action<TopicPartition, String, long, long>

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.

OnOnRestoreEnd

public Action<TopicPartition, String, long> OnOnRestoreEnd { get; set; }

Property Value

Action<TopicPartition, String, long>

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.

OnOnRestoreStart

public Action<TopicPartition, String, long, long> OnOnRestoreStart { get; set; }

Property Value

Action<TopicPartition, String, long, long>

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.

OnOnRestoreSuspended

public Action<TopicPartition, String, long> OnOnRestoreSuspended { get; set; }

Property Value

Action<TopicPartition, String, long>

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 StateRestoreListener

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

OnBatchRestored(TopicPartition, String, long, long)

public virtual void OnBatchRestored(TopicPartition arg0, String arg1, long arg2, long arg3)

Parameters

arg0 TopicPartition

TopicPartition

arg1 String

String

arg2 long

long

arg3 long

long

OnRestoreEnd(TopicPartition, String, long)

public virtual void OnRestoreEnd(TopicPartition arg0, String arg1, long arg2)

Parameters

arg0 TopicPartition

TopicPartition

arg1 String

String

arg2 long

long

OnRestoreStart(TopicPartition, String, long, long)

public virtual void OnRestoreStart(TopicPartition arg0, String arg1, long arg2, long arg3)

Parameters

arg0 TopicPartition

TopicPartition

arg1 String

String

arg2 long

long

arg3 long

long

OnRestoreSuspended(TopicPartition, String, long)

public virtual void OnRestoreSuspended(TopicPartition arg0, String arg1, long arg2)

Parameters

arg0 TopicPartition

TopicPartition

arg1 String

String

arg2 long

long

Remarks

The method invokes the default implementation in the JVM interface using OnRestoreSuspendedDefault(TopicPartition, String, long); override the method to implement a different behavior

OnRestoreSuspendedDefault(TopicPartition, String, long)

public void OnRestoreSuspendedDefault(TopicPartition arg0, String arg1, long arg2)

Parameters

arg0 TopicPartition

TopicPartition

arg1 String

String

arg2 long

long

Remarks

The method invokes the default implementation in the JVM interface