Table of Contents

Class KafkaClientSupplier

Namespace
Org.Apache.Kafka.Streams
Assembly
MASES.KNet.dll
public class KafkaClientSupplier : JVMBridgeListener, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition, IKafkaClientSupplier
Inheritance
KafkaClientSupplier
Implements
Derived

Constructors

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

Parameters

initializer IJVMBridgeBaseInitializer

KafkaClientSupplier(params object[])

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

public KafkaClientSupplier(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnGetAdmin

public Func<Map<String, object>, Admin> OnGetAdmin { get; set; }

Property Value

Func<Map<String, object>, Admin>

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.

OnGetAdminDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<Admin> OnGetAdminDispose { get; set; }

Property Value

Action<Admin>

Remarks

Set OnGetAdminDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnGetConsumer

public Func<Map<String, object>, Consumer<byte[], byte[]>> OnGetConsumer { get; set; }

Property Value

Func<Map<String, object>, Consumer<byte[], byte[]>>

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.

OnGetConsumerDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<Consumer<byte[], byte[]>> OnGetConsumerDispose { get; set; }

Property Value

Action<Consumer<byte[], byte[]>>

Remarks

Set OnGetConsumerDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnGetGlobalConsumer

public Func<Map<String, object>, Consumer<byte[], byte[]>> OnGetGlobalConsumer { get; set; }

Property Value

Func<Map<String, object>, Consumer<byte[], byte[]>>

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.

OnGetGlobalConsumerDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<Consumer<byte[], byte[]>> OnGetGlobalConsumerDispose { get; set; }

Property Value

Action<Consumer<byte[], byte[]>>

Remarks

Set OnGetGlobalConsumerDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnGetProducer

public Func<Map<String, object>, Producer<byte[], byte[]>> OnGetProducer { get; set; }

Property Value

Func<Map<String, object>, Producer<byte[], byte[]>>

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.

OnGetProducerDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<Producer<byte[], byte[]>> OnGetProducerDispose { get; set; }

Property Value

Action<Producer<byte[], byte[]>>

Remarks

Set OnGetProducerDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

OnGetRestoreConsumer

public Func<Map<String, object>, Consumer<byte[], byte[]>> OnGetRestoreConsumer { get; set; }

Property Value

Func<Map<String, object>, Consumer<byte[], byte[]>>

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.

OnGetRestoreConsumerDispose

Optional handler invoked after the event handler returns, to dispose the JVM object returned by this event.

public Action<Consumer<byte[], byte[]>> OnGetRestoreConsumerDispose { get; set; }

Property Value

Action<Consumer<byte[], byte[]>>

Remarks

Set OnGetRestoreConsumerDispose when the event handler returns a JVM-backed object that is no longer needed after the call. The handler receives the return value and is responsible for calling Dispose() on it, releasing the underlying JVM global reference immediately instead of waiting for the .NET garbage collector to finalize it. If not set, the return value is not disposed automatically.

Methods

GetAdmin(Map<String, object>)

public virtual Admin GetAdmin(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Admin

Admin

Remarks

The method invokes the default implementation in the JVM interface using GetAdminDefault(Map<String, object>); override the method to implement a different behavior

GetAdminDefault(Map<String, object>)

public Admin GetAdminDefault(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Admin

Admin

Remarks

The method invokes the default implementation in the JVM interface

GetConsumer(Map<String, object>)

public virtual Consumer<byte[], byte[]> GetConsumer(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Consumer<byte[], byte[]>

Consumer

GetGlobalConsumer(Map<String, object>)

public virtual Consumer<byte[], byte[]> GetGlobalConsumer(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Consumer<byte[], byte[]>

Consumer

GetProducer(Map<String, object>)

public virtual Producer<byte[], byte[]> GetProducer(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Producer<byte[], byte[]>

Producer

GetRestoreConsumer(Map<String, object>)

public virtual Consumer<byte[], byte[]> GetRestoreConsumer(Map<String, object> arg0)

Parameters

arg0 Map<String, object>

Map

Returns

Consumer<byte[], byte[]>

Consumer

InitializeHandlers(Type)

Handlers initializer for KafkaClientSupplier

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