RAIL_SchedulerInfo_t Struct Reference
A structure to hold information used by the scheduler.
#include <rail_types.h>
Data Fields | |
| uint8_t | priority |
| The priority for this operation in the scheduler. | |
| RAIL_Time_t | slipTime |
| The amount of time in us that this operation can slip by into the future and still be run. | |
| RAIL_Time_t | transactionTime |
| The transaction time in us for this operation. | |
A structure to hold information used by the scheduler.
For multiprotocol versions of RAIL this can be used to control how a receive or transmit operation is run. In single protocol applications it's not necessary.
Definition at line 97 of file rail_types.h.
Field Documentation
◆ priority
| uint8_t RAIL_SchedulerInfo_t::priority |
The priority for this operation in the scheduler.
This priority is used to preempt a long running lower priority task to ensure higher priority operations complete in time. A lower numerical value represents a higher logical priority meaning 0 is the highest priority and 255 is the lowest.
Definition at line 104 of file rail_types.h.
◆ slipTime
| RAIL_Time_t RAIL_SchedulerInfo_t::slipTime |
The amount of time in us that this operation can slip by into the future and still be run.
This time is relative to the start time which may be the current time for relative transmits. If we cannot start by this time the operation will be considered a failure.
Definition at line 111 of file rail_types.h.
◆ transactionTime
| RAIL_Time_t RAIL_SchedulerInfo_t::transactionTime |
The transaction time in us for this operation.
Since transaction times may not be known exactly you will likely want to use a minimum or expected guess for this time. The scheduler will use the value entered here to look for overlaps between low priority and high priority tasks and attempt to find a schedule where all tasks get to run.
Definition at line 119 of file rail_types.h.
The documentation for this struct was generated from the following file:
- common/
rail_types.h