WPILibC++
2018.4.1-20180921134745-1191-g456d3e1
|
Typedefs | |
typedef std::function< void(NT_EntryListener entry_listener, StringRef name, std::shared_ptr< Value > value, unsigned int flags)> | nt::EntryListenerCallback |
Entry listener callback function. More... | |
Functions | |
NT_EntryListener | nt::AddEntryListener (StringRef prefix, EntryListenerCallback callback, unsigned int flags) |
Add a listener for all entries starting with a certain prefix. More... | |
NT_EntryListener | nt::AddEntryListener (NT_Inst inst, const Twine &prefix, std::function< void(const EntryNotification &event)> callback, unsigned int flags) |
Add a listener for all entries starting with a certain prefix. More... | |
NT_EntryListener | nt::AddEntryListener (NT_Entry entry, std::function< void(const EntryNotification &event)> callback, unsigned int flags) |
Add a listener for a single entry. More... | |
NT_EntryListenerPoller | nt::CreateEntryListenerPoller (NT_Inst inst) |
Create a entry listener poller. More... | |
void | nt::DestroyEntryListenerPoller (NT_EntryListenerPoller poller) |
Destroy a entry listener poller. More... | |
NT_EntryListener | nt::AddPolledEntryListener (NT_EntryListenerPoller poller, const Twine &prefix, unsigned int flags) |
Create a polled entry listener. More... | |
NT_EntryListener | nt::AddPolledEntryListener (NT_EntryListenerPoller poller, NT_Entry entry, unsigned int flags) |
Create a polled entry listener. More... | |
std::vector< EntryNotification > | nt::PollEntryListener (NT_EntryListenerPoller poller) |
Get the next entry listener event. More... | |
std::vector< EntryNotification > | nt::PollEntryListener (NT_EntryListenerPoller poller, double timeout, bool *timed_out) |
Get the next entry listener event. More... | |
void | nt::CancelPollEntryListener (NT_EntryListenerPoller poller) |
Cancel a PollEntryListener call. More... | |
void | nt::RemoveEntryListener (NT_EntryListener entry_listener) |
Remove an entry listener. More... | |
bool | nt::WaitForEntryListenerQueue (NT_Inst inst, double timeout) |
Wait for the entry listener queue to be empty. More... | |
typedef std::function<void(NT_EntryListener entry_listener, StringRef name, std::shared_ptr<Value> value, unsigned int flags)> nt::EntryListenerCallback |
Entry listener callback function.
Called when a key-value pair is changed.
entry_listener | entry listener handle returned by callback creation function |
name | entry name |
value | the new value |
flags | update flags; for example, NT_NOTIFY_NEW if the key did not previously exist |
NT_EntryListener nt::AddEntryListener | ( | StringRef | prefix, |
EntryListenerCallback | callback, | ||
unsigned int | flags | ||
) |
Add a listener for all entries starting with a certain prefix.
prefix | UTF-8 string prefix |
callback | listener to add |
flags | NotifyKind bitmask |
NT_EntryListener nt::AddEntryListener | ( | NT_Inst | inst, |
const Twine & | prefix, | ||
std::function< void(const EntryNotification &event)> | callback, | ||
unsigned int | flags | ||
) |
Add a listener for all entries starting with a certain prefix.
prefix | UTF-8 string prefix |
callback | listener to add |
flags | NotifyKind bitmask |
inst | instance handle |
NT_EntryListener nt::AddEntryListener | ( | NT_Entry | entry, |
std::function< void(const EntryNotification &event)> | callback, | ||
unsigned int | flags | ||
) |
Add a listener for a single entry.
entry | entry handle |
callback | listener to add |
flags | NotifyKind bitmask |
NT_EntryListener nt::AddPolledEntryListener | ( | NT_EntryListenerPoller | poller, |
const Twine & | prefix, | ||
unsigned int | flags | ||
) |
Create a polled entry listener.
The caller is responsible for calling PollEntryListener() to poll.
poller | poller handle |
prefix | UTF-8 string prefix |
flags | NotifyKind bitmask |
NT_EntryListener nt::AddPolledEntryListener | ( | NT_EntryListenerPoller | poller, |
NT_Entry | entry, | ||
unsigned int | flags | ||
) |
Create a polled entry listener.
The caller is responsible for calling PollEntryListener() to poll.
poller | poller handle |
prefix | UTF-8 string prefix |
flags | NotifyKind bitmask |
void nt::CancelPollEntryListener | ( | NT_EntryListenerPoller | poller | ) |
Cancel a PollEntryListener call.
This wakes up a call to PollEntryListener for this poller and causes it to immediately return an empty array.
poller | poller handle |
NT_EntryListenerPoller nt::CreateEntryListenerPoller | ( | NT_Inst | inst | ) |
Create a entry listener poller.
A poller provides a single queue of poll events. Events linked to this poller (using AddPolledEntryListener()) will be stored in the queue and must be collected by calling PollEntryListener(). The returned handle must be destroyed with DestroyEntryListenerPoller().
inst | instance handle |
void nt::DestroyEntryListenerPoller | ( | NT_EntryListenerPoller | poller | ) |
Destroy a entry listener poller.
This will abort any blocked polling call and prevent additional events from being generated for this poller.
poller | poller handle |
std::vector<EntryNotification> nt::PollEntryListener | ( | NT_EntryListenerPoller | poller | ) |
Get the next entry listener event.
This blocks until the next event occurs. This is intended to be used with AddPolledEntryListener(); entry listeners created using AddEntryListener() will not be serviced through this function.
poller | poller handle |
std::vector<EntryNotification> nt::PollEntryListener | ( | NT_EntryListenerPoller | poller, |
double | timeout, | ||
bool * | timed_out | ||
) |
Get the next entry listener event.
This blocks until the next event occurs or it times out. This is intended to be used with AddPolledEntryListener(); entry listeners created using AddEntryListener() will not be serviced through this function.
poller | poller handle |
timeout | timeout, in seconds |
timed_out | true if the timeout period elapsed (output) |
void nt::RemoveEntryListener | ( | NT_EntryListener | entry_listener | ) |
Remove an entry listener.
entry_listener | Listener handle to remove |
bool nt::WaitForEntryListenerQueue | ( | NT_Inst | inst, |
double | timeout | ||
) |
Wait for the entry listener queue to be empty.
This is primarily useful for deterministic testing. This blocks until either the entry listener queue is empty (e.g. there are no more events that need to be passed along to callbacks or poll queues) or the timeout expires.
inst | instance handle |
timeout | timeout, in seconds. Set to 0 for non-blocking behavior, or a negative value to block indefinitely |