WASimCommander main namespace. Defines constants and structs used in Client-Server interactions. Many of these are needed for effective use of WASimClient, and all would be useful for custom client implementations. More...

Namespaces
namespace	CLI
	WASimCommander::CLI namespace. Container for implementation of the C++ `WASimCommander` API and `WASimClient` as a C++/CLI .NET "wrapper." The primary documentation is for the C++ version equivalents. Documentation for everything in the CLI namespace focuses primarily on any (non-obvious) differences from the C++ version.

namespace	Client
	WASimCommander::Client namespace. Defines/declares everything needed to interact with the WASimCommander Client API, including the WASimClient class itself.

namespace	Enums
	WASimCommander::Enums namespace. Contains all enum definitions for the base API.

Classes
struct	Command
	Command data structure. The member contents depend on the command type as described in each command type of the `Enums::CommandId` enum documentation. More...

struct	DataRequest
	Structure for variable value subscription requests. More...

struct	KeyEvent
	Data structure for sending Key Events to the sim with up to 5 event values. Events are specified using numeric MSFS Event IDs (names can be resolved to IDs via `Lookup` command). This supports the new functionality in MSFS SU10 with `trigger_key_event_EX1()` Gauge API function (similar to `SimConnect_TransmitClientEvent_EX1()`). The server will respond with an Ack/Nak for a `SendKey` command, echoing the given `token`. For events with zero or one value, the `SendKey` command can be used instead. More...

struct	LogRecord
	Log record structure. More...

Variables
Char array string size limits, including null terminator.
static const size_t	STRSZ_CMD = 527
	Maximum size of Command::sData member. Size optimizes alignment of `Command` struct. More...

static const size_t	STRSZ_REQ = 1030
	Maximum size for request calculator string or variable name. Size optimizes alignment of `DataRequest` struct. More...

static const size_t	STRSZ_UNIT = 37
	Maximum Unit name size. Size is of longest known unit name + 1. More...

static const size_t	STRSZ_LOG = 1031
	Size of log entry message in LogRecord::message. Size optimizes alignment of `LogRecord` struct. More...

static const size_t	STRSZ_ENAME = 64
	Maximum size of custom event name in Enums::CommandId::Register command. More...

Time periods
static const time_t	TICK_PERIOD_MS = 25
	Minimum update period for data Requests in milliseconds. Also dictates rate of some other client-specific processing on server (WASM module) side. 25ms = 40Hz. More...

static const time_t	CONN_TIMEOUT_SEC = 60 * 10
	Number of seconds after which a non-responsive client is considered disconnected. Client must respond to heartbeat pings from the server if not otherwise transmitting anything within this timeout period. More...

Predefined value types
Using these constants for the DataRequest::valueSize property will allow delta epsilon comparisons.
static const uint32_t	DATA_TYPE_INT8 = -1
	8-bit integer number (signed or unsigned) More...

static const uint32_t	DATA_TYPE_INT16 = -2
	16-bit integer number (signed or unsigned) More...

static const uint32_t	DATA_TYPE_INT32 = -3
	32-bit integer number (signed or unsigned) More...

static const uint32_t	DATA_TYPE_INT64 = -4
	64-bit integer number (signed or unsigned) More...

static const uint32_t	DATA_TYPE_FLOAT = -5
	32-bit floating-point number More...

static const uint32_t	DATA_TYPE_DOUBLE = -6
	64-bit floating-point number More...

Detailed Description

WASimCommander main namespace. Defines constants and structs used in Client-Server interactions. Many of these are needed for effective use of WASimClient, and all would be useful for custom client implementations.

Variable Documentation

◆ STRSZ_CMD

const size_t WASimCommander::STRSZ_CMD = 527

static

Maximum size of Command::sData member. Size optimizes alignment of Command struct.

Definition at line 56 of file WASimCommander.h.

◆ STRSZ_REQ

const size_t WASimCommander::STRSZ_REQ = 1030

static

Maximum size for request calculator string or variable name. Size optimizes alignment of DataRequest struct.

See also: DataRequest::nameOrCode

Definition at line 57 of file WASimCommander.h.

◆ STRSZ_UNIT

const size_t WASimCommander::STRSZ_UNIT = 37

static

Maximum Unit name size. Size is of longest known unit name + 1.

See also: DataRequest::unitName

Definition at line 58 of file WASimCommander.h.

◆ STRSZ_LOG

const size_t WASimCommander::STRSZ_LOG = 1031

static

Size of log entry message in LogRecord::message. Size optimizes alignment of LogRecord struct.

Definition at line 59 of file WASimCommander.h.

◆ STRSZ_ENAME

const size_t WASimCommander::STRSZ_ENAME = 64

static

Maximum size of custom event name in Enums::CommandId::Register command.

Definition at line 60 of file WASimCommander.h.

◆ TICK_PERIOD_MS

const time_t WASimCommander::TICK_PERIOD_MS = 25

static

Minimum update period for data Requests in milliseconds. Also dictates rate of some other client-specific processing on server (WASM module) side. 25ms = 40Hz.

Definition at line 65 of file WASimCommander.h.

◆ CONN_TIMEOUT_SEC

const time_t WASimCommander::CONN_TIMEOUT_SEC = 60 * 10

static

Number of seconds after which a non-responsive client is considered disconnected. Client must respond to heartbeat pings from the server if not otherwise transmitting anything within this timeout period.

Definition at line 66 of file WASimCommander.h.

◆ DATA_TYPE_INT8

const uint32_t WASimCommander::DATA_TYPE_INT8 = -1

static

8-bit integer number (signed or unsigned)

Definition at line 72 of file WASimCommander.h.

◆ DATA_TYPE_INT16

const uint32_t WASimCommander::DATA_TYPE_INT16 = -2

static

16-bit integer number (signed or unsigned)

Definition at line 73 of file WASimCommander.h.

◆ DATA_TYPE_INT32

const uint32_t WASimCommander::DATA_TYPE_INT32 = -3

static

32-bit integer number (signed or unsigned)

Definition at line 74 of file WASimCommander.h.

◆ DATA_TYPE_INT64

const uint32_t WASimCommander::DATA_TYPE_INT64 = -4

static

64-bit integer number (signed or unsigned)

Definition at line 75 of file WASimCommander.h.

◆ DATA_TYPE_FLOAT

const uint32_t WASimCommander::DATA_TYPE_FLOAT = -5

static

32-bit floating-point number

Definition at line 76 of file WASimCommander.h.

◆ DATA_TYPE_DOUBLE

const uint32_t WASimCommander::DATA_TYPE_DOUBLE = -6

static

64-bit floating-point number

Definition at line 77 of file WASimCommander.h.

Namespaces

Classes

Variables

Detailed Description

Variable Documentation

◆ STRSZ_CMD

◆ STRSZ_REQ

◆ STRSZ_UNIT

◆ STRSZ_LOG

◆ STRSZ_ENAME

◆ TICK_PERIOD_MS

◆ CONN_TIMEOUT_SEC

◆ DATA_TYPE_INT8

◆ DATA_TYPE_INT16

◆ DATA_TYPE_INT32

◆ DATA_TYPE_INT64

◆ DATA_TYPE_FLOAT

◆ DATA_TYPE_DOUBLE