Table of Contents

Class ConsumerPartitionAssignor

Namespace
Org.Apache.Kafka.Clients.Consumer
Assembly
MASES.KNet.dll
public class ConsumerPartitionAssignor : JVMBridgeListener, IDynamicMetaObjectProvider, IJVMBridgeCore, IEquatable<IJVMBridgeBaseInstance>, IDisposable, IJVMBridgeBaseStatic, IJVMBridgeBase, IJVMBridgeBaseInstance, IJVMBridgeDefinition, IConsumerPartitionAssignor
Inheritance
ConsumerPartitionAssignor
Implements
Derived

Constructors

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

Parameters

initializer IJVMBridgeBaseInitializer

ConsumerPartitionAssignor(params object[])

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

public ConsumerPartitionAssignor(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnAssign

public Func<Cluster, ConsumerPartitionAssignor.GroupSubscription, ConsumerPartitionAssignor.GroupAssignment> OnAssign { get; set; }

Property Value

Func<Cluster, ConsumerPartitionAssignor.GroupSubscription, ConsumerPartitionAssignor.GroupAssignment>

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.

OnAssignDispose

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

public Action<ConsumerPartitionAssignor.GroupAssignment> OnAssignDispose { get; set; }

Property Value

Action<ConsumerPartitionAssignor.GroupAssignment>

Remarks

Set OnAssignDispose 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.

OnName

public Func<String> OnName { get; set; }

Property Value

Func<String>

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.

OnNameDispose

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

public Action<String> OnNameDispose { get; set; }

Property Value

Action<String>

Remarks

Set OnNameDispose 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.

OnOnAssignment

public Action<ConsumerPartitionAssignor.Assignment, ConsumerGroupMetadata> OnOnAssignment { get; set; }

Property Value

Action<ConsumerPartitionAssignor.Assignment, ConsumerGroupMetadata>

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.

OnSubscriptionUserData

public Func<Set<String>, ByteBuffer> OnSubscriptionUserData { get; set; }

Property Value

Func<Set<String>, ByteBuffer>

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.

OnSubscriptionUserDataDispose

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

public Action<ByteBuffer> OnSubscriptionUserDataDispose { get; set; }

Property Value

Action<ByteBuffer>

Remarks

Set OnSubscriptionUserDataDispose 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.

OnSupportedProtocols

public Func<List<ConsumerPartitionAssignor.RebalanceProtocol>> OnSupportedProtocols { get; set; }

Property Value

Func<List<ConsumerPartitionAssignor.RebalanceProtocol>>

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.

OnSupportedProtocolsDispose

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

public Action<List<ConsumerPartitionAssignor.RebalanceProtocol>> OnSupportedProtocolsDispose { get; set; }

Property Value

Action<List<ConsumerPartitionAssignor.RebalanceProtocol>>

Remarks

Set OnSupportedProtocolsDispose 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.

OnVersion

public Func<short> OnVersion { get; set; }

Property Value

Func<short>

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.

OnVersionDispose

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

public Action<short> OnVersionDispose { get; set; }

Property Value

Action<short>

Remarks

Set OnVersionDispose 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

Assign(Cluster, GroupSubscription)

public virtual ConsumerPartitionAssignor.GroupAssignment Assign(Cluster arg0, ConsumerPartitionAssignor.GroupSubscription arg1)

Parameters

arg0 Cluster

Cluster

arg1 ConsumerPartitionAssignor.GroupSubscription

ConsumerPartitionAssignor.GroupSubscription

Returns

ConsumerPartitionAssignor.GroupAssignment

ConsumerPartitionAssignor.GroupAssignment

GetAssignorInstances(List<String>, Map<String, object>)

public static List<ConsumerPartitionAssignor> GetAssignorInstances(List<String> arg0, Map<String, object> arg1)

Parameters

arg0 List<String>

List

arg1 Map<String, object>

Map

Returns

List<ConsumerPartitionAssignor>

List

Remarks

The method invokes the static implementation in the JVM interface

InitializeHandlers(Type)

Handlers initializer for ConsumerPartitionAssignor

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

Name()

public virtual String Name()

Returns

String

String

OnAssignment(Assignment, ConsumerGroupMetadata)

public virtual void OnAssignment(ConsumerPartitionAssignor.Assignment arg0, ConsumerGroupMetadata arg1)

Parameters

arg0 ConsumerPartitionAssignor.Assignment

ConsumerPartitionAssignor.Assignment

arg1 ConsumerGroupMetadata

ConsumerGroupMetadata

Remarks

The method invokes the default implementation in the JVM interface using OnAssignmentDefault(Assignment, ConsumerGroupMetadata); override the method to implement a different behavior

OnAssignmentDefault(Assignment, ConsumerGroupMetadata)

public void OnAssignmentDefault(ConsumerPartitionAssignor.Assignment arg0, ConsumerGroupMetadata arg1)

Parameters

arg0 ConsumerPartitionAssignor.Assignment

ConsumerPartitionAssignor.Assignment

arg1 ConsumerGroupMetadata

ConsumerGroupMetadata

Remarks

The method invokes the default implementation in the JVM interface

SubscriptionUserData(Set<String>)

public virtual ByteBuffer SubscriptionUserData(Set<String> arg0)

Parameters

arg0 Set<String>

Set

Returns

ByteBuffer

ByteBuffer

Remarks

The method invokes the default implementation in the JVM interface using SubscriptionUserDataDefault(Set<String>); override the method to implement a different behavior

SubscriptionUserDataDefault(Set<String>)

public ByteBuffer SubscriptionUserDataDefault(Set<String> arg0)

Parameters

arg0 Set<String>

Set

Returns

ByteBuffer

ByteBuffer

Remarks

The method invokes the default implementation in the JVM interface

SupportedProtocols()

public virtual List<ConsumerPartitionAssignor.RebalanceProtocol> SupportedProtocols()

Returns

List<ConsumerPartitionAssignor.RebalanceProtocol>

List

Remarks

The method invokes the default implementation in the JVM interface using SupportedProtocolsDefault(); override the method to implement a different behavior

SupportedProtocolsDefault()

public List<ConsumerPartitionAssignor.RebalanceProtocol> SupportedProtocolsDefault()

Returns

List<ConsumerPartitionAssignor.RebalanceProtocol>

List

Remarks

The method invokes the default implementation in the JVM interface

Version()

public virtual short Version()

Returns

short

short

Remarks

The method invokes the default implementation in the JVM interface using VersionDefault(); override the method to implement a different behavior

VersionDefault()

public short VersionDefault()

Returns

short

short

Remarks

The method invokes the default implementation in the JVM interface