![]() |
VectorNav C Library
|
#include "vn/int.h"
#include "vn/error.h"
#include "vn/bool.h"
Go to the source code of this file.
Data Structures | |
struct | VnEvent |
Structure representing an event. More... | |
Functions | |
VnError | VnEvent_initialize (VnEvent *event) |
Initializes a VnEvent structure. More... | |
VnError | VnEvent_wait (VnEvent *event) |
Causes the calling thread to wait on an event until the event is signalled. More... | |
VnError | VnEvent_waitUs (VnEvent *event, uint32_t timeoutUs) |
Causes the calling thread to wait on an event until the event is signalled. More... | |
VnError | VnEvent_waitMs (VnEvent *event, uint32_t timeoutMs) |
Causes the calling thread to wait on an event until the event is signalled. More... | |
VnError | VnEvent_signal (VnEvent *event) |
Signals an event. More... | |
{COMMON_HEADER}
This header file contains structures and functions useful events and signals.
VnError VnEvent_initialize | ( | VnEvent * | event | ) |
VnError VnEvent_signal | ( | VnEvent * | event | ) |
Signals an event.
[in] | event | The associated event. |
VnError VnEvent_wait | ( | VnEvent * | event | ) |
Causes the calling thread to wait on an event until the event is signalled.
If the event is signalled, the value E_SIGNALED will be returned.
[in] | event | The associated VnEvent. |
VnError VnEvent_waitMs | ( | VnEvent * | event, |
uint32_t | timeoutMs | ||
) |
Causes the calling thread to wait on an event until the event is signalled.
If the event is signalled, the value E_SIGNALED will be returned.
[in] | event | The associated VnEvent. |
[in] | timeoutMs | The number of milliseconds to wait before the thread stops waiting on the event. If a timeout does occur, the value E_TIMEOUT will be returned. |
VnError VnEvent_waitUs | ( | VnEvent * | event, |
uint32_t | timeoutUs | ||
) |
Causes the calling thread to wait on an event until the event is signalled.
If the event is signalled, the value E_SIGNALED will be returned.
[in] | event | The associated VnEvent. |
[in] | timeoutUs | The number of microseconds to wait before the thread stops waiting on the event. If a timeout does occur, the value E_TIMEOUT will be returned. |