Function rcl_event_is_valid

Function Documentation

bool rcl_event_is_valid(const rcl_event_t *event)

Check that the event is valid.

The bool returned is false if event is invalid. The bool returned is true otherwise. In the case where false is to be returned, an error message is set. This function cannot fail.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

event[in] pointer to the rcl event

Returns:

true if event is valid, otherwise false