Table of Contents

Class Serializer

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

Constructors

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

Parameters

initializer IJVMBridgeBaseInitializer

Serializer(params object[])

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

public Serializer(params object[] args)

Parameters

args object[]

Properties

BridgeClassName

Java class name to be instantiated

public override string BridgeClassName { get; }

Property Value

string

OnClose

public Action OnClose { get; set; }

Property Value

Action

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.

OnConfigure

public Action<Map, bool> OnConfigure { get; set; }

Property Value

Action<Map, bool>

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.

OnSerialize

public Func<String, object, byte[]> OnSerialize { get; set; }

Property Value

Func<String, object, 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.

OnSerialize3

public Func<String, Headers, object, byte[]> OnSerialize3 { get; set; }

Property Value

Func<String, Headers, object, 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.

OnSerialize3Dispose

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

public Action<byte[]> OnSerialize3Dispose { get; set; }

Property Value

Action<byte[]>

Remarks

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

OnSerializeDispose

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

public Action<byte[]> OnSerializeDispose { get; set; }

Property Value

Action<byte[]>

Remarks

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

Close()

public virtual void Close()

Remarks

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

CloseDefault()

public void CloseDefault()

Remarks

The method invokes the default implementation in the JVM interface

Configure(Map, bool)

public virtual void Configure(Map arg0, bool arg1)

Parameters

arg0 Map

Map

arg1 bool

bool

Remarks

The method invokes the default implementation in the JVM interface using ConfigureDefault(Map, bool); override the method to implement a different behavior

ConfigureDefault(Map, bool)

public void ConfigureDefault(Map arg0, bool arg1)

Parameters

arg0 Map

Map

arg1 bool

bool

Remarks

The method invokes the default implementation in the JVM interface

InitializeHandlers(Type)

Handlers initializer for Serializer

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

Serialize(String, Headers, object)

public virtual byte[] Serialize(String arg0, Headers arg1, object arg2)

Parameters

arg0 String

String

arg1 Headers

Headers

arg2 object

object

Returns

byte[]

byte

Remarks

The method invokes the default implementation in the JVM interface using SerializeDefault(String, Headers, object); override the method to implement a different behavior

Serialize(String, object)

public virtual byte[] Serialize(String arg0, object arg1)

Parameters

arg0 String

String

arg1 object

object

Returns

byte[]

byte

SerializeDefault(String, Headers, object)

public byte[] SerializeDefault(String arg0, Headers arg1, object arg2)

Parameters

arg0 String

String

arg1 Headers

Headers

arg2 object

object

Returns

byte[]

byte

Remarks

The method invokes the default implementation in the JVM interface