host.anzo.eossdk.eos.sdk.init.options

Class EOS_InitializeOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.init.options.EOS_InitializeOptions

Direct Known Subclasses:

EOS_InitializeOptions.ByReference, EOS_InitializeOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","AllocateMemoryFunction","ReallocateMemoryFunction","ReleaseMemoryFunction","ProductName","ProductVersion","Reserved","SystemInitializeOptions","OverrideThreadAffinity"})
public class EOS_InitializeOptions
extends com.sun.jna.Structure

Options for initializing the Epic Online Services SDK.

Since:

8/5/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_InitializeOptions.ByReference
static class	EOS_InitializeOptions.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
EOS_AllocateMemoryFunc	AllocateMemoryFunction A custom memory allocator, if desired.
int	ApiVersion API Version: Set this to EOS_INITIALIZE_API_LATEST.
static int	EOS_INITIALIZE_API_LATEST The most recent version of the EOS_Initialize API.
static int	EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH Max length of a product name, not including the terminating null.
static int	EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH Max length of a product version, not including the terminating null.
com.sun.jna.Pointer	OverrideThreadAffinity The thread affinity override values for each category of thread.
java.lang.String	ProductName The name of the product using the Epic Online Services SDK.
java.lang.String	ProductVersion Product version of the running application.
EOS_ReallocateMemoryFunc	ReallocateMemoryFunction A corresponding memory reallocator.
EOS_ReleaseMemoryFunc	ReleaseMemoryFunction A corresponding memory releaser.
com.sun.jna.Pointer	Reserved A reserved field that should always be nulled.
com.sun.jna.Pointer	SystemInitializeOptions This field is for system specific initialization if any.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_InitializeOptions()
EOS_InitializeOptions(@NotNull EOSBaseOptions options)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_INITIALIZE_API_LATEST

public static int EOS_INITIALIZE_API_LATEST

The most recent version of the EOS_Initialize API.

EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH

public static int EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH

Max length of a product name, not including the terminating null.

EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH

public static int EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH

Max length of a product version, not including the terminating null.

ApiVersion

public int ApiVersion

API Version: Set this to EOS_INITIALIZE_API_LATEST.

AllocateMemoryFunction

public EOS_AllocateMemoryFunc AllocateMemoryFunction

A custom memory allocator, if desired.

ReallocateMemoryFunction

public EOS_ReallocateMemoryFunc ReallocateMemoryFunction

A corresponding memory reallocator. If the AllocateMemoryFunction is nulled, then this field must also be nulled.

ReleaseMemoryFunction

public EOS_ReleaseMemoryFunc ReleaseMemoryFunction

A corresponding memory releaser. If the AllocateMemoryFunction is nulled, then this field must also be nulled.

ProductName

public java.lang.String ProductName

The name of the product using the Epic Online Services SDK.

The name string is required to be non-empty and at maximum of EOS_INITIALIZEOPTIONS_PRODUCTNAME_MAX_LENGTH bytes long. The string buffer can consist of the following characters: A-Z, a-z, 0-9, dot, underscore, space, exclamation mark, question mark, and sign, hyphen, parenthesis, plus, minus, colon.

ProductVersion

public java.lang.String ProductVersion

Product version of the running application.

The version string is required to be non-empty and at maximum of EOS_INITIALIZEOPTIONS_PRODUCTVERSION_MAX_LENGTH bytes long. The string buffer can consist of the following characters: A-Z, a-z, 0-9, dot, underscore, space, exclamation mark, question mark, and sign, hyphen, parenthesis, plus, minus, colon.

Reserved

public com.sun.jna.Pointer Reserved

A reserved field that should always be nulled.

SystemInitializeOptions

public com.sun.jna.Pointer SystemInitializeOptions

This field is for system specific initialization if any.

If provided then the structure will be located in (System)/eos_system.h. The structure will be named EOS_(System)_InitializeOptions.

OverrideThreadAffinity

public com.sun.jna.Pointer OverrideThreadAffinity

The thread affinity override values for each category of thread.

Constructor Detail

EOS_InitializeOptions

public EOS_InitializeOptions()

EOS_InitializeOptions

public EOS_InitializeOptions(@NotNull
                             @NotNull EOSBaseOptions options)