JAVA-BASED REAL-TIME PROGRAMMING

RTEvent post(RTEvent e)
final void doPost(RTEvent e)
final RTEvent tryPost(RTEvent e)
final RTEvent tryPost(RTEvent e, long timeout)
3.4. Message-based communication – Mailboxes
Fetching The corresponding methods for fetching messages look as follows,
where the tryFetch methods return null if no event object was obtained.
RTEvent fetch()
final RTEvent doFetch()
final RTEvent tryFetch()
final RTEvent tryFetch(long timeout)
Control and status The following non-blocking methods can be used to
check if the buffer is empty or full.
boolean isEmpty()
boolean isFull()
For a single producing or consuming thread these methods can be useful,
but in the general case with outer threads involved the returned state
may of course be invalid already when execution continues on the next
line (due to preemption, etc.), so using the try-methods are usually
preferred.
Sometimes state or mode changes are to take place based on the state
of the buffer, and the responsible thread is to be blocked until the buffer
condition is fulfilled. The following await-methods are blocking. Examples
of use include: await all event consumed before terminating the
application, await producer started before starting operator or networking
interface, await buffer filled with event trace, and await consumer
started, respectively:
void awaitEmpty()
void awaitNotEmpty()
void awaitFull()
void awaitNotFull()
The fetchAll is to get all buffered events leaving the buffer empty. The
event that was the next to be fetched is returned as the first element
(index 0), followed by the other events in FIFO order with the most
recently posted event as the last element. An empty array (not null) is
returned if the buffer was empty. Calling flush also results in an empty
buffer.
RTEvent[] fetchAll()
void flush()
There are set and get methods for the maximum size of the buffer.
Note that if the maximum size of the buffer is decreased to less than
the current size (obtained via currentSize), the caller of setMaxSize is
blocked until the size actually has decreased to the new maximum size
(due to other threads fetching messages).
93