WPILibC++ 2027.0.0-alpha-5
Loading...
Searching...
No Matches
wpi::nt::EventFlags Struct Reference

Event notification flags. More...

#include <wpi/nt/ntcore_cpp.hpp>

Public Member Functions

 EventFlags ()=delete

Static Public Attributes

static constexpr unsigned int NONE = NT_EVENT_NONE
static constexpr unsigned int IMMEDIATE = NT_EVENT_IMMEDIATE
 Initial listener addition.
static constexpr unsigned int CONNECTED = NT_EVENT_CONNECTED
 Client connected (on server, any client connected).
static constexpr unsigned int DISCONNECTED = NT_EVENT_DISCONNECTED
 Client disconnected (on server, any client disconnected).
static constexpr unsigned int CONNECTION = CONNECTED | DISCONNECTED
 Any connection event (connect or disconnect).
static constexpr unsigned int PUBLISH = NT_EVENT_PUBLISH
 New topic published.
static constexpr unsigned int UNPUBLISH = NT_EVENT_UNPUBLISH
 Topic unpublished.
static constexpr unsigned int PROPERTIES = NT_EVENT_PROPERTIES
 Topic properties changed.
static constexpr unsigned int TOPIC = PUBLISH | UNPUBLISH | PROPERTIES
 Any topic event (publish, unpublish, or properties changed).
static constexpr unsigned int VALUE_REMOTE = NT_EVENT_VALUE_REMOTE
 Topic value updated (via network).
static constexpr unsigned int VALUE_LOCAL = NT_EVENT_VALUE_LOCAL
 Topic value updated (local).
static constexpr unsigned int VALUE_ALL = VALUE_REMOTE | VALUE_LOCAL
 Topic value updated (network or local).
static constexpr unsigned int LOG_MESSAGE = NT_EVENT_LOG_MESSAGE
 Log message.
static constexpr unsigned int TIME_SYNC = NT_EVENT_TIME_SYNC
 Time synchronized with server.

Detailed Description

Event notification flags.

The flags are a bitmask and must be OR'ed together to indicate the combination of events desired to be received.

Constructor & Destructor Documentation

◆ EventFlags()

wpi::nt::EventFlags::EventFlags ( )
delete

Member Data Documentation

◆ CONNECTED

unsigned int wpi::nt::EventFlags::CONNECTED = NT_EVENT_CONNECTED
staticconstexpr

Client connected (on server, any client connected).

◆ CONNECTION

unsigned int wpi::nt::EventFlags::CONNECTION = CONNECTED | DISCONNECTED
staticconstexpr

Any connection event (connect or disconnect).

◆ DISCONNECTED

unsigned int wpi::nt::EventFlags::DISCONNECTED = NT_EVENT_DISCONNECTED
staticconstexpr

Client disconnected (on server, any client disconnected).

◆ IMMEDIATE

unsigned int wpi::nt::EventFlags::IMMEDIATE = NT_EVENT_IMMEDIATE
staticconstexpr

Initial listener addition.

Set this flag to receive immediate notification of matches to the flag criteria.

◆ LOG_MESSAGE

unsigned int wpi::nt::EventFlags::LOG_MESSAGE = NT_EVENT_LOG_MESSAGE
staticconstexpr

Log message.

◆ NONE

unsigned int wpi::nt::EventFlags::NONE = NT_EVENT_NONE
staticconstexpr

◆ PROPERTIES

unsigned int wpi::nt::EventFlags::PROPERTIES = NT_EVENT_PROPERTIES
staticconstexpr

Topic properties changed.

◆ PUBLISH

unsigned int wpi::nt::EventFlags::PUBLISH = NT_EVENT_PUBLISH
staticconstexpr

New topic published.

◆ TIME_SYNC

unsigned int wpi::nt::EventFlags::TIME_SYNC = NT_EVENT_TIME_SYNC
staticconstexpr

Time synchronized with server.

◆ TOPIC

unsigned int wpi::nt::EventFlags::TOPIC = PUBLISH | UNPUBLISH | PROPERTIES
staticconstexpr

Any topic event (publish, unpublish, or properties changed).

◆ UNPUBLISH

unsigned int wpi::nt::EventFlags::UNPUBLISH = NT_EVENT_UNPUBLISH
staticconstexpr

Topic unpublished.

◆ VALUE_ALL

unsigned int wpi::nt::EventFlags::VALUE_ALL = VALUE_REMOTE | VALUE_LOCAL
staticconstexpr

Topic value updated (network or local).

◆ VALUE_LOCAL

unsigned int wpi::nt::EventFlags::VALUE_LOCAL = NT_EVENT_VALUE_LOCAL
staticconstexpr

Topic value updated (local).

◆ VALUE_REMOTE

unsigned int wpi::nt::EventFlags::VALUE_REMOTE = NT_EVENT_VALUE_REMOTE
staticconstexpr

Topic value updated (via network).


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