Top Description Fields Constructors Methods
org.lwjgl.util.remotery

public Class RMTSettings

extends Struct<RMTSettings>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct rmtSettings
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure to fill in to modify Remotery default settings.

Layout


struct rmtSettings {
    rmtU16 port;
    rmtBool reuse_open_port;
    rmtBool limit_connections_to_localhost;
    rmtBool enableThreadSampler;
    rmtU32 msSleepBetweenServerUpdates;
    rmtU32 messageQueueSizeInBytes;
    rmtU32 maxNbMessagesPerUpdate;
    rmtMallocPtr _malloc;
    rmtReallocPtr realloc;
    rmtFreePtr _free;
    void * mm_context;
    rmtInputHandlerPtr input_handler;
    rmtSampleTreeHandlerPtr sampletree_handler;
    void * sampletree_context;
    rmtPropertyHandlerPtr snapshot_callback;
    void * snapshot_context;
    void * input_handler_context;
    rmtPStr logPath;
}

Field Summary

Modifier and TypeField and Description
public static final int
_FREE

The struct member offsets.

public static final int
_MALLOC

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ENABLETHREADSAMPLER

The struct member offsets.

public static final int
INPUT_HANDLER

The struct member offsets.

public static final int
INPUT_HANDLER_CONTEXT

The struct member offsets.

public static final int
LIMIT_CONNECTIONS_TO_LOCALHOST

The struct member offsets.

public static final int
LOGPATH

The struct member offsets.

public static final int
MAXNBMESSAGESPERUPDATE

The struct member offsets.

public static final int
MESSAGEQUEUESIZEINBYTES

The struct member offsets.

public static final int
MM_CONTEXT

The struct member offsets.

public static final int
MSSLEEPBETWEENSERVERUPDATES

The struct member offsets.

public static final int
PORT

The struct member offsets.

public static final int
REALLOC

The struct member offsets.

public static final int
REUSE_OPEN_PORT

The struct member offsets.

public static final int
SAMPLETREE_CONTEXT

The struct member offsets.

public static final int
SAMPLETREE_HANDLER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SNAPSHOT_CALLBACK

The struct member offsets.

public static final int
SNAPSHOT_CONTEXT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
RMTSettings(long address, ByteBuffer container)

public
RMTSettings(ByteBuffer container)

Creates a RMTSettings instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public RMTFree
_free()

callback pointer for memory allocation

public RMTSettings
_free(RMTFreeI value)

Sets the specified value to the _free field.

public RMTMalloc
_malloc()

callback pointer for memory allocation

public RMTSettings
_malloc(RMTMallocI value)

Sets the specified value to the _malloc field.

public static RMTSettings
calloc()

Returns a new RMTSettings instance allocated with memCalloc.

public static RMTSettings
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new RMTSettings instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static RMTSettings
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static RMTSettings
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected RMTSettings
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static RMTSettings
create()

Returns a new RMTSettings instance allocated with BufferUtils.

public static RMTSettings
create(long address)

Returns a new RMTSettings instance for the specified memory address.

public static RMTSettings
createSafe(long address)

Like create, but returns null if address is NULL.

public boolean
enableThreadSampler()

Whether to enable runtime thread sampling that discovers which processors a thread is running on.

public RMTSettings
enableThreadSampler(boolean value)

Sets the specified value to the enableThreadSampler field.

public RMTInputHandler
input_handler()

callback pointer for receiving input from the Remotery console

public RMTSettings
input_handler(RMTInputHandlerI value)

Sets the specified value to the input_handler field.

public long
input_handler_context()

context pointer that gets sent to Remotery console callback function

public RMTSettings
input_handler_context(long value)

Sets the specified value to the input_handler_context field.

public boolean
limit_connections_to_localhost()

Only allow connections on localhost?

public RMTSettings
limit_connections_to_localhost(boolean value)

Sets the specified value to the limit_connections_to_localhost field.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the logPath field.
logPath()

public RMTSettings
logPath(ByteBuffer value)

Sets the address of the specified encoded string to the logPath field.

public String

Returns:

the null-terminated string pointed to by the logPath field.
logPathString()

public static RMTSettings
malloc()

Returns a new RMTSettings instance allocated with memAlloc.

public static RMTSettings
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new RMTSettings instance allocated on the specified MemoryStack.

public static RMTSettings
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static RMTSettings
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
maxNbMessagesPerUpdate()

if the user continuously pushes to the message queue, the server network code won't get a chance to update unless there's an upper-limit on how many messages can be consumed per loop

public RMTSettings
maxNbMessagesPerUpdate(int value)

Sets the specified value to the maxNbMessagesPerUpdate field.

public int
messageQueueSizeInBytes()

size of the internal message queues Remotery uses.

public RMTSettings
messageQueueSizeInBytes(int value)

Sets the specified value to the messageQueueSizeInBytes field.

public long
mm_context()

memory allocation context pointer

public RMTSettings
mm_context(long value)

Sets the specified value to the mm_context field.

public int
msSleepBetweenServerUpdates()

how long to sleep between server updates, hopefully trying to give a little CPU back to other threads

public RMTSettings
msSleepBetweenServerUpdates(int value)

Sets the specified value to the msSleepBetweenServerUpdates field.

public static RMTFree
n_free(long struct)

Unsafe version of _free.

public static void
n_free(long struct, RMTFreeI value)

Unsafe version of _free.

public static RMTMalloc
n_malloc(long struct)

Unsafe version of _malloc.

public static void
n_malloc(long struct, RMTMallocI value)

Unsafe version of _malloc.

public static int
nenableThreadSampler(long struct)

Unsafe version of enableThreadSampler.

public static void
nenableThreadSampler(long struct, int value)

Unsafe version of enableThreadSampler.

public static RMTInputHandler
ninput_handler(long struct)

Unsafe version of input_handler.

public static void
ninput_handler(long struct, RMTInputHandlerI value)

Unsafe version of input_handler.

public static long
ninput_handler_context(long struct)

Unsafe version of input_handler_context.

public static void
ninput_handler_context(long struct, long value)

Unsafe version of input_handler_context.

public static int
nlimit_connections_to_localhost(long struct)

Unsafe version of limit_connections_to_localhost.

public static void
nlimit_connections_to_localhost(long struct, int value)

Unsafe version of limit_connections_to_localhost.

public static ByteBuffer
nlogPath(long struct)

Unsafe version of logPath.

public static void
nlogPath(long struct, ByteBuffer value)

Unsafe version of logPath.

public static String
nlogPathString(long struct)

Unsafe version of logPathString.

public static int
nmaxNbMessagesPerUpdate(long struct)

Unsafe version of maxNbMessagesPerUpdate.

public static void
nmaxNbMessagesPerUpdate(long struct, int value)

Unsafe version of maxNbMessagesPerUpdate.

public static int
nmessageQueueSizeInBytes(long struct)

Unsafe version of messageQueueSizeInBytes.

public static void
nmessageQueueSizeInBytes(long struct, int value)

Unsafe version of messageQueueSizeInBytes.

public static long
nmm_context(long struct)

Unsafe version of mm_context.

public static void
nmm_context(long struct, long value)

Unsafe version of mm_context.

public static int
nmsSleepBetweenServerUpdates(long struct)

Unsafe version of msSleepBetweenServerUpdates.

public static void
nmsSleepBetweenServerUpdates(long struct, int value)

Unsafe version of msSleepBetweenServerUpdates.

public static short
nport(long struct)

Unsafe version of port.

public static void
nport(long struct, short value)

Unsafe version of port.

public static RMTRealloc
nrealloc(long struct)

Unsafe version of realloc.

public static void
nrealloc(long struct, RMTReallocI value)

Unsafe version of realloc.

public static int
nreuse_open_port(long struct)

Unsafe version of reuse_open_port.

public static void
nreuse_open_port(long struct, int value)

Unsafe version of reuse_open_port.

public static long
nsampletree_context(long struct)

Unsafe version of sampletree_context.

public static void
nsampletree_context(long struct, long value)

Unsafe version of sampletree_context.

public static RMTSampleTreeHandler
nsampletree_handler(long struct)

Unsafe version of sampletree_handler.

public static void
nsampletree_handler(long struct, RMTSampleTreeHandlerI value)

Unsafe version of sampletree_handler.

public static RMTPropertyHandler
nsnapshot_callback(long struct)

Unsafe version of snapshot_callback.

public static void
nsnapshot_callback(long struct, RMTPropertyHandlerI value)

Unsafe version of snapshot_callback.

public static long
nsnapshot_context(long struct)

Unsafe version of snapshot_context.

public static void
nsnapshot_context(long struct, long value)

Unsafe version of snapshot_context.

public short
port()

which port to listen for incoming connections on

public RMTSettings
port(short value)

Sets the specified value to the port field.

public RMTRealloc
realloc()

callback pointer for memory allocation

public RMTSettings
realloc(RMTReallocI value)

Sets the specified value to the realloc field.

public boolean
reuse_open_port()

when this server exits it can leave the port open in TIME_WAIT state for a while.

public RMTSettings
reuse_open_port(boolean value)

Sets the specified value to the reuse_open_port field.

public long

Returns:

the value of the sampletree_context field.
sampletree_context()

public RMTSettings
sampletree_context(long value)

Sets the specified value to the sampletree_context field.

public RMTSampleTreeHandler
sampletree_handler()

callback pointer for traversing the sample tree graph

public RMTSettings
sampletree_handler(RMTSampleTreeHandlerI value)

Sets the specified value to the sampletree_handler field.

public RMTSettings
set(short port, boolean reuse_open_port, boolean limit_connections_to_localhost, boolean enableThreadSampler, int msSleepBetweenServerUpdates, int messageQueueSizeInBytes, int maxNbMessagesPerUpdate, RMTMallocI _malloc, RMTReallocI realloc, RMTFreeI _free, long mm_context, RMTInputHandlerI input_handler, RMTSampleTreeHandlerI sampletree_handler, long sampletree_context, RMTPropertyHandlerI snapshot_callback, long snapshot_context, long input_handler_context, ByteBuffer logPath)

Initializes this struct with the specified values.

public RMTSettings

Returns:

this struct
set(RMTSettings
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public RMTPropertyHandler
snapshot_callback()

callback pointer for traversing the property graph

public RMTSettings
snapshot_callback(RMTPropertyHandlerI value)

Sets the specified value to the snapshot_callback field.

public long

Returns:

the value of the snapshot_context field.
snapshot_context()

public RMTSettings
snapshot_context(long value)

Sets the specified value to the snapshot_context field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate