GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBS / V2-10-10
Constituent: pbs     Tag: sun-gcc
#include "PBS/LI_pubdefs.h"
#include "PBS/PL_comdefs.h"
#include "PBS/TOC_comdefs.h"
Include dependency graph for FORK.h:
This graph shows which files directly or indirectly include this file:
Data Structures | |
union | _FORK_node |
Structure defining a FORK_node. More... | |
struct | _FORK_msg_hdr |
All messages queued by the FORK routines must be prefaced by this controlling structure. More... | |
struct | _FORK_msg_sys |
A predefined message consisting of a FORK_msg_hdr and a single 32-bit location to hold the contents. More... | |
struct | _FORK_que_cfg |
Describes the configuration of a que. More... | |
Typedefs | |
typedef _FORK_msg_hdr | FORK_msg_hdr |
Typedef for struct _FORK_msg_hdr. | |
typedef _FORK_que | FORK_que |
Typedef for a FORK que. To the user this is an opaque handle. | |
typedef enum _FORK_type | FORK_type |
Typedef for the enum _FORK_type. | |
typedef enum _FORK_cb_status | FORK_cb_status |
Typedef for enum _FORK_cb_status. | |
typedef void * | FORK_cb_prm |
Typedef for the FORK callback parameter. | |
typedef FORK_cb_status(* | FORK_cb_rtn )(FORK_cb_prm context, FORK_msg_hdr *msg_hdr) |
Signature of the FORK callback handler. | |
typedef int(* | FORK_cb_modify )(FORK_cb_prm context, FORK_msg_hdr *msg_hdr) |
Signature of the FORK modify callback handler. | |
typedef _FORK_node | FORK_node |
Typedef for a FORK_node. | |
typedef _FORK_msg_sys | FORK_msg_sys |
Typedef for struct _FORK_msg_sys. | |
typedef _FORK_que_cfg | FORK_que_cfg |
Typedef for struct _FORK_que_cfg. | |
typedef PL_list | FORK_que_list |
Used to enable and disable lists of ques. | |
typedef _FORK_fcb | FORK_fcb |
Typedef for struct _FORK_fcb. | |
Enumerations | |
enum | _FORK_type { FORK_K_TYPE_LOCKING_ONLY = RW_K_TYPE_LOCKING_ONLY, FORK_K_TYPE_PENDING = RW_K_TYPE_PENDING, FORK_K_TYPE_PENDING_WTO = RW_K_TYPE_PENDING_WTO, FORK_K_TYPE_PENDING_FIFO = RW_K_TYPE_PENDING_FIFO, FORK_K_TYPE_PENDING_FIFO_WTO = RW_K_TYPE_PENDING_FIFO_WTO, FORK_K_TYPE_PENDING_PRIORITY = RW_K_TYPE_PENDING_PRIORITY, FORK_K_TYPE_PENDING_PRIORITY_WTO = RW_K_TYPE_PENDING_PRIORITY_WTO } |
Enumerates the different pending types. This determines the behaviour when one attempts to allocate a system message from an empty list. More... | |
enum | _FORK_cb_status { FORK_C_CONTINUE = 0 } |
Enumerates the status of the call back routine. More... | |
Functions | |
int | FORK_fcb_sizeof (int nques) |
Returns the size, in bytes, of a FORK Control Block. | |
int | FORK_create (FORK_fcb *fcb, const struct _TASK_attr *attr, FORK_cb_rtn def_handler, FORK_cb_prm ctx, FORK_cb_prm tmo_ctx, const TOC *tmo_toc, int nques, const FORK_que_cfg *que_cfg, FORK_type msg_type, FORK_msg_sys *msg_blks, int msg_cnt) |
Creates a FORK message que. | |
int | FORK_destroy (FORK_fcb *fcb) |
Destroys a FORK que. | |
FORK_que_list | FORK_disable (FORK_fcb *fcb, FORK_que_list disable_list) |
Disables the servicing of the specified ques. | |
FORK_que_list | FORK_enable (FORK_fcb *fcb, FORK_que_list enable_list) |
Enables the servicing of the specified ques. | |
FORK_que_list | FORK_enabled (const FORK_fcb *fcb) |
Returns the enable/disabled state of the specified que. | |
int | FORK_join (FORK_fcb *fcb, int *exit_status) |
Waits until the FORK'd task is deleted. | |
int | FORK_qdisable (FORK_que *que) |
Disables the servicing of the specified que. | |
int | FORK_qenable (FORK_que *que) |
Enables the servicing of the specified que. | |
int | FORK_qenabled (const FORK_que *que) |
Returns the enable/disabled state of all ques. | |
int | FORK_qtail_modify (FORK_que *que, FORK_cb_modify modify, void *parameter) |
Sneaky way to modify the tail (newest) element on the specified FORK que. | |
int | FORK_qhead_modify (FORK_que *que, FORK_cb_modify modify, void *parameter) |
Sneaky way to modify the head (oldest) element on the specified FORK que. | |
int | FORK_qsys (FORK_que *que, FORK_cb_rtn handler, void *contents) |
Ques a message using the internal FORK message blocks. | |
int | FORK_qsysW (FORK_que *que, FORK_cb_rtn handler, void *contents) |
Ques a message using the internal FORK message blocks. | |
int | FORK_qsysW_toc (FORK_que *que, FORK_cb_rtn handler, void *contents, const TOC *tmo_toc) |
Ques a message using the internal FORK message blocks. | |
int | FORK_qusr (FORK_que *que, FORK_cb_rtn handler, FORK_msg_hdr *msg_hdr) |
Ques a user composed message. | |
int | FORK_resume (FORK_fcb *fcb) |
Resumes a previously suspended FORK task. | |
int | FORK_suspend (FORK_fcb *fcb) |
Suspends the FORK task. | |
FORK_que * | FORK_que_get (FORK_fcb *fcb, int que_id) |
Returns a handle to the specified que. |
CVS $Id: FORK.h,v 1.7 2004/10/20 14:36:51 russell Exp $
|
Signature of the FORK modify callback handler. Defines the signature for the user callback & parameter
ret_code = (*cb_rtn) (FORK_cb_prm cb_prm, FORK_msg_hdr *msg_hdr) Where: cb_prm: The value of the context parameter passed into the FORK_qxxxx_modify routine. msg_hdr: A pointer to the message header of the message to be modified. This pointer will, in all likelihood, be recasted by the into a pointer to the specific style of message the user is expecting. ret_code: An arbitrary 32-bit integer passed back to the caller of FORK_qhead_modify() or FORK_qtail_modify().
|
|
Typedef for the FORK callback parameter. This parameter is specified when calling FORK_create() and is passed transparently into the user's callback handler. |
|
Signature of the FORK callback handler. Defines the signature for the user callback & parameter
status = (*cb_rtn) (FORK_cb_prm cb_prm, FORK_msg_hdr *msg_hdr) Where: cb_prm: The value of the context parameter passed into the FORK_create routines. msg_hdr: A pointer to the message header. This pointer will, in all likelihood, be recasted into a pointer to the specific style of message one is expecting. RETURN VALUE: FORK_C_CONTINUE 0), keep going, anything else kill the FORK process. |
|
Typedef for struct _FORK_fcb. This block contains all the one time initialization parameters and serves as the caller's handle to the create FORK que. The free message list is used if and only if the user requests the creation of an internal que. |
|
Typedef for struct _FORK_msg_sys. This is a the message that is queued by the FORK_qsysXXX's routine. It consists of about the minimal usable message, a message header and one 4 byte location to store the message contents in. |
|
Typedef for a FORK_node.
|
|
Typedef for struct _FORK_que_cfg. This describes the properties of a que when the FORK facility is setup to handle multiple ques. This includes a default callback routine and parameter to be associated with the que. |
|
Enumerates the status of the call back routine. This enumerates the return value of the user's dispatch callback handler. Any value but FORK_C_CONTINUE (0) causes the FORK'd task to delete itself. |
|
|
Creates a FORK message que.
|
|
Destroys a FORK que.
The usual method of winding down the FORK task is for the parent task to send a QUIT message to the FORK'd task. The parent task then calls FORK_join, which block until the FORK'd task exits. The FORK'd task performs any necessary clean-up then returns a non-zero status code from the callback routine. This causes the FORK'd task to delete itself, allowing the FORK_join() call to complete.
|
|
Disables the servicing of the specified ques.
|
|
Enables the servicing of the specified ques.
|
|
Returns the enable/disabled state of the specified que.
|
|
Returns the size, in bytes, of a FORK Control Block.
The FORK routines are capable of supporting multiple prioritized internal ques. This is done by specifying nques to be greater than 1. |
|
Waits until the FORK'd task is deleted.
The usual method of winding down the FORK task is for the parent task to send a QUIT message to the FORK'd task. The parent task then calls FORK_join, which block until the FORK'd task exits. The FORK'd task performs any necessary clean-up then returns a non-zero status code from the callback routine. (This status code is returned to the user as exit_status.) This causes the FORK'd task to delete itself, allowing the FORK_join() call to complete. The user is then free to call FORK_destroy() to return the resources garnered by the FORK fcb. Note that the exit_status may be returned as any non-zero 32-bit value. This includes returning a pointer to a structure which may contain additional information. If one does this, one must be careful to ensure that the memory is viable after task deletion. For instance, don't return pointers to things on the stack. |
|
Disables the servicing of the specified que.
|
|
Enables the servicing of the specified que.
|
|
Returns the enable/disabled state of all ques.
|
|
Sneaky way to modify the head (oldest) element on the specified FORK que.
|
|
Ques a message using the internal FORK message blocks.
Note that because the message is internally allocated it may be possible that this list is exhausted. This version of the routine returns immediately with failure if the list is exhausted. See FORK_qsysW() or FORK_qsysW_toc for wait forever and wait with a timeout versions |
|
Ques a message using the internal FORK message blocks.
Note that because the message is internally allocated it may be possible that this list is exhausted. This version of the routine waits indefinitely until a message becomes available. See FORK_qsys() or FORK_qsysW_toc for no wait and wait with timeout versions. |
|
Ques a message using the internal FORK message blocks.
Note that because the message is internally allocated it may be possible that this list is exhausted. A timeout parameter is provided to handle this situation. See FORK_qsys() or FORK_qsysW for no wait and wait forever versions. |
|
Sneaky way to modify the tail (newest) element on the specified FORK que.
|
|
Returns a handle to the specified que.
|
|
Ques a user composed message.
For the extra work involved in using this routine, the user gets to control his own memory allocation and the exact contents of the message. This means that there is almost no case, other than an internal corruption, under which this routine can fail. |
|
Resumes a previously suspended FORK task.
|
|
Suspends the FORK task.
|