Gin
Loading...
Searching...
No Matches
Public Attributes | List of all members
RemoteServer::Options Struct Reference

#include <gin_remoteserver.h>

Public Attributes

int port = 27182
 First port to try.
 
int portRange = 16
 Ports port .
 
juce::String bindAddress = "127.0.0.1"
 Interface to listen on.
 
int messageThreadTimeoutMs = 10000
 How long a command may wait for the message thread before failing.
 
juce::String appName
 Name reported by ping and written to the discovery file.
 
bool writeDiscoveryFile = true
 Write a small json file to <temp>/gin_remote/<port>.json so clients can find running servers.
 
bool captureLogger = true
 Route juce::Logger output into the log command's buffer.
 
bool moveRealCursor = true
 Move the real cursor to the point being clicked.
 

Member Data Documentation

◆ port

int RemoteServer::Options::port = 27182

First port to try.

The GIN_REMOTE_PORT environment variable overrides this.

◆ portRange

int RemoteServer::Options::portRange = 16

Ports port .

. port + portRange - 1 are tried in turn, so several instances can run at once.

◆ bindAddress

juce::String RemoteServer::Options::bindAddress = "127.0.0.1"

Interface to listen on.

Keep this loopback unless you know what you are doing.

◆ messageThreadTimeoutMs

int RemoteServer::Options::messageThreadTimeoutMs = 10000

How long a command may wait for the message thread before failing.

◆ appName

juce::String RemoteServer::Options::appName

Name reported by ping and written to the discovery file.

Defaults to the app or plugin name.

◆ writeDiscoveryFile

bool RemoteServer::Options::writeDiscoveryFile = true

Write a small json file to <temp>/gin_remote/<port>.json so clients can find running servers.

◆ captureLogger

bool RemoteServer::Options::captureLogger = true

Route juce::Logger output into the log command's buffer.

◆ moveRealCursor

bool RemoteServer::Options::moveRealCursor = true

Move the real cursor to the point being clicked.

JUCE reports the OS cursor position for MouseInputSource::getScreenPosition(), so code that asks what is under the mouse only agrees with injected events if the cursor is actually there. Costs you your cursor while a client drives the UI.


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