Skip to content

RemoteManagerAPI ​

cpp
#include <VAmiga.h>
cpp
class RemoteManagerAPI

Defined in VAmiga.h:2421

API of the remote manager.

Public Methods ​

ReturnNameDescription
const RemoteManagerInfo &getInfo constReturns the component's current state.
const RemoteManagerInfo &getCachedInfo constReturns the most recent state snapshot recorded by the emulator thread (see getInfo()).
voidsendSends a raw payload through the specified remote server. It is delivered through the server's currently configured transport and silently dropped if no client is connected.

getInfo ​

const

cpp
const RemoteManagerInfo & getInfo() const

Defined in VAmiga.h:2441

Returns the component's current state.

getInfo() reads the live state on the calling thread. The result is only consistent if the emulator is paused or suspended. getCachedInfo() returns the snapshot the emulator thread has recorded most recently, which is the one to use while the emulator runs. Both return references that can be overwritten by a later call or by the emulator thread, so copy the data if you need to keep it.


getCachedInfo ​

const

cpp
const RemoteManagerInfo & getCachedInfo() const

Defined in VAmiga.h:2443

Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).


send ​

cpp
void send(ServerType server, const string & payload)

Defined in VAmiga.h:2455

Sends a raw payload through the specified remote server. It is delivered through the server's currently configured transport and silently dropped if no client is connected.

Parameters ​

ParameterTypeDescription
serverServerTypeThe server to send through.
payloadconst string &The raw payload to send.