An interface defining the framework options for JuggerNET. More...

Inheritance diagram for Codemesh.JuggerNET.IOptions:

Public Member Functions
void	SetTraceLevel (TraceFacility fac, TraceLevel level)
	Set the trace level for a trace facility. More...

TraceLevel	GetTraceLevel (TraceFacility fac)
	Query the trace level for a trace facility. More...

void	SetTraceFile (string name, int numFilesToRetain)
	Sets both the trace file name and the number of old files to retain in one operation. More...

Properties
string	JvmPath `[get, set]`
	The JVM that is to be used in in-process mode. This is the full path to a file which is usually called jvm.dll and is in a subdirectory of the Java Runtime Environment (JRE). More...

string	DefaultJvmPath `[get]`
	The JVM that would be selected by the runtime library to be used in in-process mode if no JvmPath is specified explicitly. This is the full path to a file which is usually called jvm.dll and is in a subdirectory of a Java Runtime Environment (JRE). This is a read-only property that allows you to query the choice made by the runtime. More...

bool	NoshutdownProcessing `[get, set]`
	Governs whether the application should attempt to perform cleanup in the JVM when shutting down. This defaults to `false`, but some applications may require setting this property to `true` if they experience shutdown crashes. More...

string	TraceFile `[get, set]`
	A file into which trace messages are written. If not specified, all tracing output is going to `stdout`. More...

int	TraceFileCount `[get, set]`
	The number of old trace files to retain. More...

TraceCallback	TraceMethod `[get, set]`
	Allows you to register a custom tracing method. More...

bool	Remote `[get, set]`
	Specifies whether to use in-process or out-of-process runtime mode. If you use a value of `true` here, you will need to configure at least the `IRemoteOptions.ConnectionString` property. More...

int	MilliSecondsToForcedGC `[get, set]`
	Specifies the number of milliseconds between forced garbage collections to alleviate memory pressure on the Java heap. The default value is 1000. A value of 0 disables forced garbage collection. More...

int	NumObjectsToForcedGC `[get, set]`
	Specifies the number of prxoy objects that need to be instantiated before a forced garbage collection takes place to alleviate memory pressure on the Java heap. The default value is 10,000. A value of 0 disables forced garbage collection. More...

string	SkipTypeAnalysisForTheseAssemblies `[get, set]`
	Specifies semicolon-separated list of assembly name fragments that refer to assemblies that should be skipped during proxy type analysis. More...

string	PerformTypeAnalysisForTheseAssemblies `[get, set]`
	Specifies semicolon-separated list of assembly name fragments that refer to assemblies that are the only assemblies that are to be analyzed for the presence of proxy types. More...

ExceptionHandlerCallback	ExceptionHandler `[get, set]`
	Specifies the callback that you can use to customize the type of exception that is thrown by the JuggerNET framework. More...

Detailed Description

An interface defining the framework options for JuggerNET.

Member Function Documentation

◆ GetTraceLevel()

TraceLevel Codemesh.JuggerNET.IOptions.GetTraceLevel ( TraceFacility fac )

Query the trace level for a trace facility.

Parameters

fac	The trace facility for which we want to know the current trace level.

Returns

Implemented in Codemesh.JuggerNET.JvmLoader.

◆ SetTraceFile()

void Codemesh.JuggerNET.IOptions.SetTraceFile	(	string	name,
		int	numFilesToRetain
	)

Sets both the trace file name and the number of old files to retain in one operation.

Parameters

name	The trace file name.
numFilesToRetain	The number of old trace files to retain.

Implemented in Codemesh.JuggerNET.JvmLoader.

◆ SetTraceLevel()

void Codemesh.JuggerNET.IOptions.SetTraceLevel	(	TraceFacility	fac,
		TraceLevel	level
	)

Set the trace level for a trace facility.

Parameters

fac	The trace facility(s) for which we're applying a trace level.
level	The trace level we're applying.

Implemented in Codemesh.JuggerNET.JvmLoader.

Referenced by Codemesh.JuggerNET.JvmLoader.GetJvmLoader().

Property Documentation

◆ DefaultJvmPath

string Codemesh.JuggerNET.IOptions.DefaultJvmPath

get

The JVM that would be selected by the runtime library to be used in in-process mode if no JvmPath is specified explicitly. This is the full path to a file which is usually called jvm.dll and is in a subdirectory of a Java Runtime Environment (JRE). This is a read-only property that allows you to query the choice made by the runtime.

The default JVM that would be used in in-process mode if JvmPath is not specified explicitly.

◆ ExceptionHandler

ExceptionHandlerCallback Codemesh.JuggerNET.IOptions.ExceptionHandler

getset

Specifies the callback that you can use to customize the type of exception that is thrown by the JuggerNET framework.

◆ JvmPath

string Codemesh.JuggerNET.IOptions.JvmPath

getset

The JVM that is to be used in in-process mode. This is the full path to a file which is usually called jvm.dll and is in a subdirectory of the Java Runtime Environment (JRE).

The JVM that is to be used in in-process mode.

◆ MilliSecondsToForcedGC

int Codemesh.JuggerNET.IOptions.MilliSecondsToForcedGC

getset

Specifies the number of milliseconds between forced garbage collections to alleviate memory pressure on the Java heap. The default value is 1000. A value of 0 disables forced garbage collection.

The number of milliseconds between forced garbage collections.

Referenced by Codemesh.JuggerNET.JvmLoader.GetJvmLoader().

◆ NoshutdownProcessing

bool Codemesh.JuggerNET.IOptions.NoshutdownProcessing

getset

Governs whether the application should attempt to perform cleanup in the JVM when shutting down. This defaults to false, but some applications may require setting this property to true if they experience shutdown crashes.

Governs whether the application should attempt to perform cleanup in the JVM when shutting down.

◆ NumObjectsToForcedGC

int Codemesh.JuggerNET.IOptions.NumObjectsToForcedGC

getset

Specifies the number of prxoy objects that need to be instantiated before a forced garbage collection takes place to alleviate memory pressure on the Java heap. The default value is 10,000. A value of 0 disables forced garbage collection.

The number of proxy object creations between forced garbage collections.

Referenced by Codemesh.JuggerNET.JvmLoader.GetJvmLoader().

◆ PerformTypeAnalysisForTheseAssemblies

string Codemesh.JuggerNET.IOptions.PerformTypeAnalysisForTheseAssemblies

getset

Specifies semicolon-separated list of assembly name fragments that refer to assemblies that are the only assemblies that are to be analyzed for the presence of proxy types.

The analysis of all loaded assemblies can have a negative impact on load time of a .NET application that uses a lot of assemblies, particularly when large third-party assemblies are part of the mix. The SkipTypeAnalysisForTheseAssemblies property is the prefered way of declaratively skipping certain assemblies from being analyzed. The PerformTypeAnalysisForTheseAssemblies property allows you to specify the assemblies that you do wish to be analyzed.

This is a much more dangerous operation because you might be adding other proxy assemblies to your application at a later point. Forgetting to amend this property will not cause any compilation errors, but it will cause hard-to-debug runtime errors. We added this property solely for the rare scenario of applications with a short list of constant proxy assemblies and a long lists of assembly dependencies that change frequently.

PerformTypeAnalysisForTheseAssemblies = "MyUtility;PublicKeyToken=b03f5f7f11d50a3a";

◆ Remote

bool Codemesh.JuggerNET.IOptions.Remote

getset

Specifies whether to use in-process or out-of-process runtime mode. If you use a value of true here, you will need to configure at least the IRemoteOptions.ConnectionString property.

The flag indicating whether or not to use a shared JVM.

◆ SkipTypeAnalysisForTheseAssemblies

string Codemesh.JuggerNET.IOptions.SkipTypeAnalysisForTheseAssemblies

getset

Specifies semicolon-separated list of assembly name fragments that refer to assemblies that should be skipped during proxy type analysis.

The analysis of all loaded assemblies can have a negative impact on load time of a .NET application that uses a lot of assemblies, particularly when large third-party assemblies are part of the mix. This property allows you to specify assembly (full)name fragments that will cause the matching assemblies to be skipped. Make sure that the skipped assemblies do not contain proxy types, otherwise you might receive strange runtime results for method invocations or field accesses.

SkipTypeAnalysisForTheseAssemblies = "MyUtility;PublicKeyToken=b03f5f7f11d50a3a";

◆ TraceFile

string Codemesh.JuggerNET.IOptions.TraceFile

getset

A file into which trace messages are written. If not specified, all tracing output is going to stdout.

A file into which trace messages are written.

◆ TraceFileCount

int Codemesh.JuggerNET.IOptions.TraceFileCount

getset

The number of old trace files to retain.

A number. Zero means that no old files are retained.

◆ TraceMethod

TraceCallback Codemesh.JuggerNET.IOptions.TraceMethod

getset

Allows you to register a custom tracing method.

The custom tracing method delegate.

The documentation for this interface was generated from the following file:

IOptions.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ GetTraceLevel()

◆ SetTraceFile()

◆ SetTraceLevel()

Property Documentation

◆ DefaultJvmPath

◆ ExceptionHandler

◆ JvmPath

◆ MilliSecondsToForcedGC

◆ NoshutdownProcessing

◆ NumObjectsToForcedGC

◆ PerformTypeAnalysisForTheseAssemblies

◆ Remote

◆ SkipTypeAnalysisForTheseAssemblies

◆ TraceFile

◆ TraceFileCount

◆ TraceMethod