Table of Contents

Class KNetCommon

Namespace
MASES.KNet.Connect
Assembly
MASES.KNet.dll

The generic class which is the base of the KNet Connect SDK classes

public abstract class KNetCommon : IKNetCommon, IKNetConnectLogging
Inheritance
KNetCommon
Implements
Derived
Inherited Members

Constructors

KNetCommon()

Initializer

protected KNetCommon()

Properties

IsDebugEnabled

Reports if debug level is enabled

public bool IsDebugEnabled { get; }

Property Value

bool

IsErrorEnabled

Reports if error level is enabled

public bool IsErrorEnabled { get; }

Property Value

bool

IsInfoEnabled

Reports if info level is enabled

public bool IsInfoEnabled { get; }

Property Value

bool

IsTraceEnabled

Reports if trace level is enabled

public bool IsTraceEnabled { get; }

Property Value

bool

IsWarnEnabled

Reports if warning level is enabled

public bool IsWarnEnabled { get; }

Property Value

bool

LogCheckInterval

The interval, expressed in milliseconds, in which the enable status of the log is checked

protected double LogCheckInterval { get; set; }

Property Value

double

Remarks

The to zero the log check is disabled and enable verification is bypassed

Name

Reports the name of the logger

public string Name { get; }

Property Value

string

Properties

The properties received during configuration step

public IKNetConfigurationFromMap Properties { get; protected set; }

Property Value

IKNetConfigurationFromMap

ReflectedRemoteObjectClassName

The unique name used to map objects between JVM and .NET

protected abstract string ReflectedRemoteObjectClassName { get; }

Property Value

string

Remarks

This value is used when KNet Connect SDK is hosted in the CLR. When KNet Connect SDK starts from the JVM it is ignored.

UniqueId

Returns the unique id of this instance

protected string UniqueId { get; }

Property Value

string

Methods

DataToExchange(object)

An helper function to read the data from Java side

protected void DataToExchange(object data)

Parameters

data object

Exceptions

InvalidOperationException

DataToExchange<T>()

An helper function to read the data from Java side

protected T DataToExchange<T>()

Returns

T

The T

Type Parameters

T

The expected return Type

Exceptions

InvalidOperationException

ExecuteOnRemote(string, params object[])

An helper function to execute operation in the Java side

public void ExecuteOnRemote(string method, params object[] args)

Parameters

method string

Method name to be invoked

args object[]

Arguments of the method to be invoked

Exceptions

InvalidOperationException

ExecuteOnRemote<T>(string, params object[])

An helper function to operation in the Java side

public T ExecuteOnRemote<T>(string method, params object[] args)

Parameters

method string

Method name to be invoked

args object[]

Arguments of the method to be invoked

Returns

T

The T

Type Parameters

T

The expected return Type

Exceptions

InvalidOperationException

LogDebug(string)

Write a debug string into Apache Connect tracing subsystem

public void LogDebug(string var1)

Parameters

var1 string

String to write

LogDebug(string, JVMBridgeException)

Write a debug string into Apache Connect tracing subsystem

public void LogDebug(string var1, JVMBridgeException var2)

Parameters

var1 string

String to write

var2 JVMBridgeException

Associated JVMBridgeException

LogDebug(string, params object[])

Write a debug string into Apache Connect tracing subsystem

public void LogDebug(string var1, params object[] var2)

Parameters

var1 string

String to write

var2 object[]

The array of object to format var1

Remarks

Since the counter-part is based on log4j or slf4j the parameters in var2 will be applied on var1 using the rules defined from log4j or slf4j; see https://www.slf4j.org/api/org/slf4j/Logger.html

LogError(string)

Write a error into Apache Connect tracing subsystem

public void LogError(string var1)

Parameters

var1 string

String to write

LogError(string, JVMBridgeException)

Write a error into Apache Connect tracing subsystem

public void LogError(string var1, JVMBridgeException var2)

Parameters

var1 string

String to write

var2 JVMBridgeException

Associated JVMBridgeException

LogError(string, params object[])

Write a error string into Apache Connect tracing subsystem

public void LogError(string var1, params object[] var2)

Parameters

var1 string

String to write

var2 object[]

The array of object to format var1

Remarks

Since the counter-part is based on log4j or slf4j the parameters in var2 will be applied on var1 using the rules defined from log4j or slf4j; see https://www.slf4j.org/api/org/slf4j/Logger.html

LogInfo(string)

Write a info string into Apache Connect tracing subsystem

public void LogInfo(string var1)

Parameters

var1 string

String to write

LogInfo(string, JVMBridgeException)

Write a info string into Apache Connect tracing subsystem

public void LogInfo(string var1, JVMBridgeException var2)

Parameters

var1 string

String to write

var2 JVMBridgeException

Associated JVMBridgeException

LogInfo(string, params object[])

Write a info string into Apache Connect tracing subsystem

public void LogInfo(string var1, params object[] var2)

Parameters

var1 string

String to write

var2 object[]

The array of object to format var1

Remarks

Since the counter-part is based on log4j or slf4j the parameters in var2 will be applied on var1 using the rules defined from log4j or slf4j; see https://www.slf4j.org/api/org/slf4j/Logger.html

LogTrace(string)

Write a trace string into Apache Connect tracing subsystem

public void LogTrace(string var1)

Parameters

var1 string

String to write

LogTrace(string, JVMBridgeException)

Write a trace string log into Apache Connect tracing subsystem

public void LogTrace(string var1, JVMBridgeException var2)

Parameters

var1 string

String to write

var2 JVMBridgeException

Associated JVMBridgeException

LogTrace(string, params object[])

Write a trace string into Apache Connect tracing subsystem

public void LogTrace(string var1, params object[] var2)

Parameters

var1 string

String to write

var2 object[]

The array of object to format var1

Remarks

Since the counter-part is based on log4j or slf4j the parameters in var2 will be applied on var1 using the rules defined from log4j or slf4j; see https://www.slf4j.org/api/org/slf4j/Logger.html

LogWarn(string)

Write a warning string into Apache Connect tracing subsystem

public void LogWarn(string var1)

Parameters

var1 string

String to write

LogWarn(string, JVMBridgeException)

Write a warning string into Apache Connect tracing subsystem

public void LogWarn(string var1, JVMBridgeException var2)

Parameters

var1 string

String to write

var2 JVMBridgeException

Associated JVMBridgeException

LogWarn(string, params object[])

Write a warning string into Apache Connect tracing subsystem

public void LogWarn(string var1, params object[] var2)

Parameters

var1 string

String to write

var2 object[]

The array of object to format var1

Remarks

Since the counter-part is based on log4j or slf4j the parameters in var2 will be applied on var1 using the rules defined from log4j or slf4j; see https://www.slf4j.org/api/org/slf4j/Logger.html

Edit this page