RTEMS: Classic API Options

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Files | Macros | Typedefs
Classic API Options
API » Classic

## Files
file | options.h

## Macros
#define | RTEMS_DEFAULT_OPTIONS 0x00000000
#define | RTEMS_WAIT 0x00000000
#define | RTEMS_NO_WAIT 0x00000001
#define | RTEMS_EVENT_ALL 0x00000000
#define | RTEMS_EVENT_ANY 0x00000002

## Typedefs
typedef uint32_t | rtems_option

## Detailed Description

This encapsulates functionality related to the options argument to Classic API blocking operations. The primary option is whether or not a task is willing to wait for the operation to complete.

## Macro Definition Documentation

## ◆ RTEMS_DEFAULT_OPTIONS

#define RTEMS_DEFAULT_OPTIONS 0x00000000

The following constants define the individual options which may be used to compose an option set.

## ◆ RTEMS_EVENT_ALL

#define RTEMS_EVENT_ALL 0x00000000

This option constants indicates that the task wishes to wait until all events of interest are available.

## ◆ RTEMS_EVENT_ANY

#define RTEMS_EVENT_ANY 0x00000002

This option constants indicates that the task wishes to wait until ANY events of interest are available.

## ◆ RTEMS_NO_WAIT

#define RTEMS_NO_WAIT 0x00000001

This option constants indicates that the task is to not wait on the resource. If it is not available, return immediately with a status to indicate unsatisfied.

## ◆ RTEMS_WAIT

#define RTEMS_WAIT 0x00000000

This option constants indicates that the task is to wait on resource.

## Typedef Documentation

## ◆ rtems_option

typedef uint32_t rtems_option

The following type defines the control block used to manage option sets.