Package org.lwjgl.util.remotery

Class RMTSettings

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<RMTSettings>
org.lwjgl.util.remotery.RMTSettings
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class RMTSettings extends org.lwjgl.system.Struct<RMTSettings> implements org.lwjgl.system.NativeResource
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 Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • PORT

      public static final int PORT
      The struct member offsets.

    • REUSE_OPEN_PORT

      public static final int REUSE_OPEN_PORT
      The struct member offsets.

    • LIMIT_CONNECTIONS_TO_LOCALHOST

      public static final int LIMIT_CONNECTIONS_TO_LOCALHOST
      The struct member offsets.

    • ENABLETHREADSAMPLER

      public static final int ENABLETHREADSAMPLER
      The struct member offsets.

    • MSSLEEPBETWEENSERVERUPDATES

      public static final int MSSLEEPBETWEENSERVERUPDATES
      The struct member offsets.

    • MESSAGEQUEUESIZEINBYTES

      public static final int MESSAGEQUEUESIZEINBYTES
      The struct member offsets.

    • MAXNBMESSAGESPERUPDATE

      public static final int MAXNBMESSAGESPERUPDATE
      The struct member offsets.

    • _MALLOC

      public static final int _MALLOC
      The struct member offsets.

    • REALLOC

      public static final int REALLOC
      The struct member offsets.

    • _FREE

      public static final int _FREE
      The struct member offsets.

    • MM_CONTEXT

      public static final int MM_CONTEXT
      The struct member offsets.

    • INPUT_HANDLER

      public static final int INPUT_HANDLER
      The struct member offsets.

    • SAMPLETREE_HANDLER

      public static final int SAMPLETREE_HANDLER
      The struct member offsets.

    • SAMPLETREE_CONTEXT

      public static final int SAMPLETREE_CONTEXT
      The struct member offsets.

    • SNAPSHOT_CALLBACK

      public static final int SNAPSHOT_CALLBACK
      The struct member offsets.

    • SNAPSHOT_CONTEXT

      public static final int SNAPSHOT_CONTEXT
      The struct member offsets.

    • INPUT_HANDLER_CONTEXT

      public static final int INPUT_HANDLER_CONTEXT
      The struct member offsets.

    • LOGPATH

      public static final int LOGPATH
      The struct member offsets.

  • Constructor Details

    • RMTSettings

      public RMTSettings(ByteBuffer container)
      Creates a RMTSettings instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<RMTSettings>

    • port

      public short port()
      which port to listen for incoming connections on

    • reuse_open_port

      public boolean reuse_open_port()
      when this server exits it can leave the port open in TIME_WAIT state for a while. This forces subsequent server bind attempts to fail when restarting. If you find restarts fail repeatedly with bind attempts, set this to true to forcibly reuse the open port.

    • limit_connections_to_localhost

      public boolean limit_connections_to_localhost()
      Only allow connections on localhost?

      For dev builds you may want to access your game from other devices but if you distribute a game to your players with Remotery active, probably best to limit connections to localhost.

    • enableThreadSampler

      public boolean enableThreadSampler()
      Whether to enable runtime thread sampling that discovers which processors a thread is running on.

      This will suspend and resume threads from outside repeatdly and inject code into each thread that automatically instruments the processor.

      Default: Enabled

    • msSleepBetweenServerUpdates

      public int msSleepBetweenServerUpdates()
      how long to sleep between server updates, hopefully trying to give a little CPU back to other threads

    • messageQueueSizeInBytes

      public int messageQueueSizeInBytes()
      size of the internal message queues Remotery uses. Will be rounded to page granularity of 64k.

    • maxNbMessagesPerUpdate

      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

    • _malloc

      public RMTMalloc _malloc()
      callback pointer for memory allocation

    • realloc

      public RMTRealloc realloc()
      callback pointer for memory allocation

    • _free

      public RMTFree _free()
      callback pointer for memory allocation

    • mm_context

      public long mm_context()
      memory allocation context pointer

    • input_handler

      public @Nullable RMTInputHandler input_handler()
      callback pointer for receiving input from the Remotery console

    • sampletree_handler

      public @Nullable RMTSampleTreeHandler sampletree_handler()
      callback pointer for traversing the sample tree graph

    • sampletree_context

      public long sampletree_context()
      Returns:
      the value of the sampletree_context field.

    • snapshot_callback

      public @Nullable RMTPropertyHandler snapshot_callback()
      callback pointer for traversing the property graph

    • snapshot_context

      public long snapshot_context()
      Returns:
      the value of the snapshot_context field.

    • input_handler_context

      public long input_handler_context()
      context pointer that gets sent to Remotery console callback function

    • logPath

      public @Nullable ByteBuffer logPath()
      Returns:
      a ByteBuffer view of the null-terminated string pointed to by the logPath field.

    • logPathString

      public @Nullable String logPathString()
      Returns:
      the null-terminated string pointed to by the logPath field.

    • port

      public RMTSettings port(short value)
      Sets the specified value to the port() field.

    • reuse_open_port

      public RMTSettings reuse_open_port(boolean value)
      Sets the specified value to the reuse_open_port() field.

    • limit_connections_to_localhost

      public RMTSettings limit_connections_to_localhost(boolean value)
      Sets the specified value to the limit_connections_to_localhost() field.

    • enableThreadSampler

      public RMTSettings enableThreadSampler(boolean value)
      Sets the specified value to the enableThreadSampler() field.

    • msSleepBetweenServerUpdates

      public RMTSettings msSleepBetweenServerUpdates(int value)
      Sets the specified value to the msSleepBetweenServerUpdates() field.

    • messageQueueSizeInBytes

      public RMTSettings messageQueueSizeInBytes(int value)
      Sets the specified value to the messageQueueSizeInBytes() field.

    • maxNbMessagesPerUpdate

      public RMTSettings maxNbMessagesPerUpdate(int value)
      Sets the specified value to the maxNbMessagesPerUpdate() field.

    • _malloc

      public RMTSettings _malloc(RMTMallocI value)
      Sets the specified value to the _malloc() field.

    • realloc

      public RMTSettings realloc(RMTReallocI value)
      Sets the specified value to the realloc() field.

    • _free

      public RMTSettings _free(RMTFreeI value)
      Sets the specified value to the _free() field.

    • mm_context

      public RMTSettings mm_context(long value)
      Sets the specified value to the mm_context() field.

    • input_handler

      public RMTSettings input_handler(@Nullable RMTInputHandlerI value)
      Sets the specified value to the input_handler() field.

    • sampletree_handler

      public RMTSettings sampletree_handler(@Nullable RMTSampleTreeHandlerI value)
      Sets the specified value to the sampletree_handler() field.

    • sampletree_context

      public RMTSettings sampletree_context(long value)
      Sets the specified value to the sampletree_context field.

    • snapshot_callback

      public RMTSettings snapshot_callback(@Nullable RMTPropertyHandlerI value)
      Sets the specified value to the snapshot_callback() field.

    • snapshot_context

      public RMTSettings snapshot_context(long value)
      Sets the specified value to the snapshot_context field.

    • input_handler_context

      public RMTSettings input_handler_context(long value)
      Sets the specified value to the input_handler_context() field.

    • logPath

      public RMTSettings logPath(@Nullable ByteBuffer value)
      Sets the address of the specified encoded string to the logPath field.

    • set

      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, @Nullable RMTInputHandlerI input_handler, @Nullable RMTSampleTreeHandlerI sampletree_handler, long sampletree_context, @Nullable RMTPropertyHandlerI snapshot_callback, long snapshot_context, long input_handler_context, @Nullable ByteBuffer logPath)
      Initializes this struct with the specified values.

    • set

      public RMTSettings set(RMTSettings src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static RMTSettings malloc()
      Returns a new RMTSettings instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static RMTSettings calloc()
      Returns a new RMTSettings instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static RMTSettings create()
      Returns a new RMTSettings instance allocated with BufferUtils.

    • create

      public static RMTSettings create(long address)
      Returns a new RMTSettings instance for the specified memory address.

    • createSafe

      public static @Nullable RMTSettings createSafe(long address)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static RMTSettings mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static RMTSettings callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static RMTSettings mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static RMTSettings callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • malloc

      public static RMTSettings malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new RMTSettings instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static RMTSettings calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new RMTSettings instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • nport

      public static short nport(long struct)
      Unsafe version of port().

    • nreuse_open_port

      public static int nreuse_open_port(long struct)
      Unsafe version of reuse_open_port().

    • nlimit_connections_to_localhost

      public static int nlimit_connections_to_localhost(long struct)
      Unsafe version of limit_connections_to_localhost().

    • nenableThreadSampler

      public static int nenableThreadSampler(long struct)
      Unsafe version of enableThreadSampler().

    • nmsSleepBetweenServerUpdates

      public static int nmsSleepBetweenServerUpdates(long struct)
      Unsafe version of msSleepBetweenServerUpdates().

    • nmessageQueueSizeInBytes

      public static int nmessageQueueSizeInBytes(long struct)
      Unsafe version of messageQueueSizeInBytes().

    • nmaxNbMessagesPerUpdate

      public static int nmaxNbMessagesPerUpdate(long struct)
      Unsafe version of maxNbMessagesPerUpdate().

    • n_malloc

      public static RMTMalloc n_malloc(long struct)
      Unsafe version of _malloc().

    • nrealloc

      public static RMTRealloc nrealloc(long struct)
      Unsafe version of realloc().

    • n_free

      public static RMTFree n_free(long struct)
      Unsafe version of _free().

    • nmm_context

      public static long nmm_context(long struct)
      Unsafe version of mm_context().

    • ninput_handler

      public static @Nullable RMTInputHandler ninput_handler(long struct)
      Unsafe version of input_handler().

    • nsampletree_handler

      public static @Nullable RMTSampleTreeHandler nsampletree_handler(long struct)
      Unsafe version of sampletree_handler().

    • nsampletree_context

      public static long nsampletree_context(long struct)
      Unsafe version of sampletree_context().

    • nsnapshot_callback

      public static @Nullable RMTPropertyHandler nsnapshot_callback(long struct)
      Unsafe version of snapshot_callback().

    • nsnapshot_context

      public static long nsnapshot_context(long struct)
      Unsafe version of snapshot_context().

    • ninput_handler_context

      public static long ninput_handler_context(long struct)
      Unsafe version of input_handler_context().

    • nlogPath

      public static @Nullable ByteBuffer nlogPath(long struct)
      Unsafe version of logPath().

    • nlogPathString

      public static @Nullable String nlogPathString(long struct)
      Unsafe version of logPathString().

    • nport

      public static void nport(long struct, short value)
      Unsafe version of port.

    • nreuse_open_port

      public static void nreuse_open_port(long struct, int value)
      Unsafe version of reuse_open_port.

    • nlimit_connections_to_localhost

      public static void nlimit_connections_to_localhost(long struct, int value)
      Unsafe version of limit_connections_to_localhost.

    • nenableThreadSampler

      public static void nenableThreadSampler(long struct, int value)
      Unsafe version of enableThreadSampler.

    • nmsSleepBetweenServerUpdates

      public static void nmsSleepBetweenServerUpdates(long struct, int value)
      Unsafe version of msSleepBetweenServerUpdates.

    • nmessageQueueSizeInBytes

      public static void nmessageQueueSizeInBytes(long struct, int value)
      Unsafe version of messageQueueSizeInBytes.

    • nmaxNbMessagesPerUpdate

      public static void nmaxNbMessagesPerUpdate(long struct, int value)
      Unsafe version of maxNbMessagesPerUpdate.

    • n_malloc

      public static void n_malloc(long struct, RMTMallocI value)
      Unsafe version of _malloc.

    • nrealloc

      public static void nrealloc(long struct, RMTReallocI value)
      Unsafe version of realloc.

    • n_free

      public static void n_free(long struct, RMTFreeI value)
      Unsafe version of _free.

    • nmm_context

      public static void nmm_context(long struct, long value)
      Unsafe version of mm_context.

    • ninput_handler

      public static void ninput_handler(long struct, @Nullable RMTInputHandlerI value)
      Unsafe version of input_handler.

    • nsampletree_handler

      public static void nsampletree_handler(long struct, @Nullable RMTSampleTreeHandlerI value)
      Unsafe version of sampletree_handler.

    • nsampletree_context

      public static void nsampletree_context(long struct, long value)
      Unsafe version of sampletree_context.

    • nsnapshot_callback

      public static void nsnapshot_callback(long struct, @Nullable RMTPropertyHandlerI value)
      Unsafe version of snapshot_callback.

    • nsnapshot_context

      public static void nsnapshot_context(long struct, long value)
      Unsafe version of snapshot_context.

    • ninput_handler_context

      public static void ninput_handler_context(long struct, long value)
      Unsafe version of input_handler_context.

    • nlogPath

      public static void nlogPath(long struct, @Nullable ByteBuffer value)
      Unsafe version of logPath.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate