Difference between revisions of "Truxton message set queue is empty"
Jump to navigation
Jump to search
(Created page with "Tells the receiver that their message queue is empty. =Syntax= <syntaxhighlight lang="C"> void truxton_message_set_queue_is_empty( uint64_t message_handle, uint32_t value );...") |
|||
| Line 2: | Line 2: | ||
=Syntax= | =Syntax= | ||
| − | < | + | <source lang="C"> |
void truxton_message_set_queue_is_empty( uint64_t message_handle, uint32_t value ); | void truxton_message_set_queue_is_empty( uint64_t message_handle, uint32_t value ); | ||
| − | </ | + | </source> |
=Parameters= | =Parameters= | ||
| Line 18: | Line 18: | ||
=Sample= | =Sample= | ||
| − | < | + | <source lang="C" highlight="7"> |
| − | void test_message(uint64_t truxton) | + | void test_message( uint64_t truxton ) |
{ | { | ||
uint64_t message = truxton_message_create(); | uint64_t message = truxton_message_create(); | ||
| Line 36: | Line 36: | ||
truxton_message_destroy( message ); | truxton_message_destroy( message ); | ||
} | } | ||
| − | </ | + | </source> |
Latest revision as of 12:28, 9 February 2021
Tells the receiver that their message queue is empty.
Syntax
void truxton_message_set_queue_is_empty( uint64_t message_handle, uint32_t value );
Parameters
message_handle
The handle to a message created by the truxton_message_create call.
value
A non-zero value signifies that the message queue is empty.
Remarks
It should be noted that setting this property has no affect when sending the message to a message queue via the truxton_route_message() call.
This field is set by Truxton when it retrieves a message from the queue.
Sample
void test_message( uint64_t truxton )
{
uint64_t message = truxton_message_create();
truxton_message_set_truxton( message, truxton );
truxton_message_set_queue_is_empty( message, 1 );
int return_value = handle_message( message );
if ( return_value == 0 )
{
printf( "Failed to handle an empty-queue message.\n" );
}
truxton_message_destroy( message );
}
