WASimClient.h File Reference

#include <cstdint>
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include <Windows.h>
#include "WASimCommander.h"
#include "client/exports.h"
#include "client/enums.h"
#include "client/structs.h"

Go to the source code of this file.

Classes
class	WASimCommander::Client::WASimClient
	WASimCommander Client implementation. Handles all aspects of communication with the WASimCommander Server WASM module. More...

Namespaces
namespace	WASimCommander
	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.
namespace	WASimCommander::Client
	WASimCommander::Client namespace. Defines/declares everything needed to interact with the WASimCommander Client API, including the WASimClient class itself.

Macros
#define	WIN32_LEAN_AND_MEAN
#define	WSMCMND_CLIENT_USE_CONCURRENT_CALLBACKS   1
	Define with value of 0 (zero) to invoke all callbacks consecutively, using a mutex lock. Default is (possible) concurrent invocation. Callbacks may still arrive from different threads.

Typedefs
using	WASimCommander::Client::clientEventCallback_t = std::function<void __stdcall(const ClientEvent &)>
	Callback function for Client events.
using	WASimCommander::Client::listResultsCallback_t = std::function<void __stdcall(const ListResult &)>
	Callback function for delivering list results, eg. of local variables sent from Server.
using	WASimCommander::Client::dataCallback_t = std::function<void __stdcall(const DataRequestRecord &)>
	Callback function for subscription result data.
using	WASimCommander::Client::logCallback_t = std::function<void __stdcall(const LogRecord &, LogSource)>
	Callback function for log entries (from both Client and Server).
using	WASimCommander::Client::commandCallback_t = std::function<void __stdcall(const Command &)>
	Callback function for commands sent from server.

Variables
static const uint32_t	WASimCommander::Client::CUSTOM_KEY_EVENT_ID_MIN = 0x00020000
	Starting ID range for "Custom Key Events" for use with registerCustomKeyEvent() generated IDs. (This corresponds to the value of 1 + THIRD_PARTY_EVENT_ID_MAX constant from SimConnect SDK header file 'MSFS/Legacy/gauges.h'.)
Return result values
static const HRESULT	WASimCommander::Client::E_NOT_CONNECTED = 2250L | ( 7 << 16) | 0x80000000
	Error result: server not connected.
static const HRESULT	WASimCommander::Client::E_TIMEOUT = 1460L | ( 7 << 16) | 0x80000000
	Error result: timeout communicating with server.

Macro Definition Documentation

WIN32_LEAN_AND_MEAN

#define WIN32_LEAN_AND_MEAN

Definition at line 28 of file WASimClient.h.

WSMCMND_CLIENT_USE_CONCURRENT_CALLBACKS

#define WSMCMND_CLIENT_USE_CONCURRENT_CALLBACKS   1

Define with value of 0 (zero) to invoke all callbacks consecutively, using a mutex lock. Default is (possible) concurrent invocation. Callbacks may still arrive from different threads.

Definition at line 41 of file WASimClient.h.