dispatch_handler()

Updated: May 06, 2022

Handle events received by dispatch_block()

Synopsis:

#include <sys/iofunc.h>
#include <sys/dispatch.h>

int dispatch_handler( dispatch_context_t * ctp );

Arguments:

ctp
A pointer to a dispatch_context_t structure that was allocated by dispatch_context_alloc().

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The dispatch_handler() function handles events received by dispatch_block() and does one of the following:

This function is part of the dispatch layer of a resource manager. For more information, see Layers in a resource manager in the Bones of a Resource Manager chapter of Writing a Resource Manager.

Returns:

0
Success.
-1
One of the following occurred:
  • The ctp was NULL.
  • The rcvid in the ctp was -1 and no timeout handler was found.
  • The message length was less than 2 bytes. A 2-byte message type is required at the beginning of the message so that a handler function can be found or identified. When there's no 2-byte message type, MsgError() is called to return EINVAL to the client.
  • No matching handler was found for the message or pulse received. In this case, MsgError() is called to return ENOSYS to the client.
  • A handler was found for the message, but the handler determined that there was a problem.

Examples:

#include <stdlib.h>
#include <sys/dispatch.h>

int main( int argc, char **argv ) {
   dispatch_context_t   *ctp;
   …

   for(;;) {
     if( dispatch_block( ctp ) ) {
       dispatch_handler( ctp );
     }
   }
   return EXIT_SUCCESS;
}

For examples using the dispatch interface, see dispatch_create(), message_attach(), resmgr_attach(), and thread_pool_create().

Classification:

QNX Neutrino

Safety:  
Cancellation point Read the Caveats
Interrupt handler No
Signal handler No
Thread Yes

Caveats:

This function might or might not be a cancellation point, depending on the implementation of the handler.