Difference between revisions of "Truxton message get queue is empty"

From truxwiki.com
Jump to navigation Jump to search
 
Line 2: Line 2:
  
 
=Syntax=
 
=Syntax=
<syntaxhighlight lang="C">
+
<source lang="C">
 
uint32_t truxton_message_get_queue_is_empty( uint64_t message_handle );
 
uint32_t truxton_message_get_queue_is_empty( uint64_t message_handle );
</syntaxhighlight>
+
</source>
  
 
=Parameters=
 
=Parameters=
Line 14: Line 14:
  
 
=Sample=
 
=Sample=
<syntaxhighlight lang="C" highlight="3">
+
<source lang="C" highlight="3">
void check_message(uint64_t message)
+
void check_message( uint64_t message )
 
{
 
{
 
   if ( truxton_message_queue_is_empty( message ) == 0 )
 
   if ( truxton_message_queue_is_empty( message ) == 0 )
Line 26: Line 26:
 
   }
 
   }
 
}
 
}
</syntaxhighlight>
+
</source>

Latest revision as of 12:28, 9 February 2021

Tells you if your message queue is empty.

Syntax

uint32_t truxton_message_get_queue_is_empty( uint64_t message_handle );

Parameters

message_handle

The handle to a message created by the truxton_message_create call.

Return value

If the message queue doesn't contain any messages, the return value will be 1, otherwise it will be zero.

Sample

void check_message( uint64_t message )
{
   if ( truxton_message_queue_is_empty( message ) == 0 )
   {
      printf( "We should proceed\n" );
   }
   else
   {
      printf( "Queue is empty, we should sleep or exit\n" );
   }
}