dispatch_destroy()

Destroy a dispatch handle

Synopsis:

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

int dispatch_destroy( dispatch_t *dpp );

Arguments:

dpp: A dispatch handle created by a successful call to dispatch_create().

Library:

libc

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

Description:

The function dispatch_destroy() destroys the given dispatch handle.

Returns:

0: Success.
-1: An error occurred (errno is set).

Errors:

EINVAL: The dispatch handle, dpp, is invalid.

Examples:

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

int main( int argc, char **argv ) {
   dispatch_t    *dpp;
   int           destroyed;

   if( ( dpp = dispatch_create() ) == NULL ) {
     fprintf( stderr, "%s: Unable to allocate \
              dispatch handle.\n",argv[0] );
     return EXIT_FAILURE;
   }

   …
    
   if ( (destroyed = dispatch_destroy ( dpp )) == -1 ) {
      fprintf ( stderr, "Dispatch wasn't destroyed, \
                bad dispatch handle %d.\n", dpp);
      return EXIT_FAILURE;
   }
   /* else dispatch was destroyed */

   …
   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	No
Interrupt handler	No
Signal handler	No
Thread	Yes