PL_type.h File Reference

Priority Lists, priority list types. More...

#include <PBS/RW_type.h>

Typedefs
typedef enum _PL_type	PL_type
	Typedef for enum _PL_type.
Enumerations
enum	_PL_type {   PL_K_TYPE_LOCKING_ONLY = RW_K_TYPE_LOCKING_ONLY,   PL_K_TYPE_PENDING = RW_K_TYPE_PENDING,   PL_K_TYPE_PENDING_WTO = RW_K_TYPE_PENDING_WTO,   PL_K_TYPE_PENDING_FIFO = RW_K_TYPE_PENDING_FIFO,   PL_K_TYPE_PENDING_FIFO_WTO = RW_K_TYPE_PENDING_FIFO_WTO,   PL_K_TYPE_PENDING_PRIORITY = RW_K_TYPE_PENDING_PRIORITY,   PL_K_TYPE_PENDING_PRIORITY_WTO = RW_K_TYPE_PENDING_PRIORITY_WTO }
	Enumerates the types of PL lists available. More...

---

Detailed Description

Priority Lists, priority list types.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: PL_type.h,v 1.4 2011/03/24 23:05:43 apw Exp $

SYNOPSIS

This type predominately determines the behaviour attempts to remove a node from an empty priority list.

---

Typedef Documentation

PL_type

Typedef for enum _PL_type.

The timeout types allow high resolution timeouts to be specified. If this option is not specified, only native (read ticks in VxWorks and all timeouts on POSIX platforms) are allowed.

There are two basic pend types types:

• FIFO - tasks will be awakened on a FIFO basis
• PRIORITY - tasks will be awakened on PRIORITY basis.

This controls how the wake-up order when multiple consumers pend on the same PL. In my estimation, this is not a good thing to do, so in almost all case the user should pick either PL_K_TYPE_PENDKING or PL_K_TYPE_PENDING_WTO.

---

Enumeration Type Documentation

enum _PL_type

Enumerates the types of PL lists available.

Enumerator:

PL_K_TYPE_LOCKING_ONLY	Locking mechanism only, no pending mechanism available
PL_K_TYPE_PENDING	Pending mechanism available, single pender/reader only
PL_K_TYPE_PENDING_WTO	Pending with timeouts, single pender/reader only
PL_K_TYPE_PENDING_FIFO	Use FIFO pending order
PL_K_TYPE_PENDING_FIFO_WTO	Use FIFO pending order with timeouts available
PL_K_TYPE_PENDING_PRIORITY	Use PRIORITY pending order
PL_K_TYPE_PENDING_PRIORITY_WTO	Use PRIORITY pending order with timeouts available