GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > MSG / V3-0-0
Constituent: msg_mt     Tag: linux-gcc
#include "PBS/TASK.h"
#include "PBS/WCT.h"
#include "MDB/MDB_pubdefs.h"
#include "MSG/MSG_macdefs.h"
Include dependency graph for MSG_pubdefs.h:
This graph shows which files directly or indirectly include this file:
Data Structures | |
struct | _MSG_Counts |
Structure for instrumentation counts. More... | |
struct | _MSG_InitPrm |
Structure to hold parameters needed by MSG initialization routine. More... | |
struct | _MSG_Message |
Structure to hold an instance of a message. More... | |
Defines | |
#define | MSG_K_FMTBITS 2 |
N-bits needed to type a substitution. | |
#define | MSG_M_FMTBITS (( 1 << MSG_K_FMTBITS ) - 1 ) |
Mask for above. | |
#define | MSG_L_FMTMAX ( 32 / MSG_K_FMTBITS ) |
Maximum number of substitutions. | |
#define | MSG_K_FMTSTRING 0 |
Conversion type pointer to string. | |
#define | MSG_K_FMT4BINT 1 |
Conversion type 4-byte integer. | |
#define | MSG_K_FMT8BINT 2 |
Conversion type 8-byte integer. | |
#define | MSG_K_FMTDOUBLE 3 |
Conversion type double (any float). | |
#define | MSG_L_FMTLENGTH 256 |
Maximum length of a formatting string. | |
Typedefs | |
typedef _MSG_OutputRtn | MSG_OutputRtn |
Typedef for struct _MSG_OutputRtn. | |
typedef enum _MSG_Level | MSG_Level |
Typedef for enum _MSG_Level. | |
typedef enum _MSG_OutputModes | MSG_OutputModes |
Typedef for enum _MSG_OutputModes. | |
typedef _MSG_InitPrm | MSG_InitPrm |
Typedef for struct _MSG_InitPrm. | |
typedef _MSG_Message | MSG_Message |
Typedef for struct _MSG_Message. | |
typedef _MSG_Counts | MSG_Counts |
Typedef for struct _MSG_Counts. | |
typedef void | MSG_cb_OutputRtn (MSG_OutputModes mode, void *prm, const MSG_Message *msg) |
Signature for a MSG processing callback routine. | |
Enumerations | |
enum | _MSG_Level { MSG_LVL_SUCCESS = 0, MSG_LVL_INFORMATION = 1, MSG_LVL_WARNING = 2, MSG_LVL_ERROR = 3 } |
Enumerate message severity levels. More... | |
enum | _MSG_OutputModes { MSG_OUT_INIT = 0, MSG_OUT_NORMAL = 1, MSG_OUT_EXIT = 2 } |
Enumeration of modes in which output processors can be called. More... | |
Functions | |
unsigned int | MSG_attachOutputRtn (MSG_OutputRtn **handle, MSG_cb_OutputRtn *rtn, void *prm) |
Attach a message output callback routine. | |
unsigned int | MSG_configure (void) |
Configure and start the MSG task. | |
unsigned int | MSG_countsSinceReset (MSG_Counts *cnt, unsigned int rst) |
Return instrumentation counts since last reset. | |
unsigned int | MSG_countsSinceStart (MSG_Counts *cnt) |
Return instrumentation counts since message task started. | |
unsigned int | MSG_detachOutputRtn (MSG_OutputRtn *handle) |
Detach a message callback routine. | |
unsigned int | MSG_initialize (const MSG_InitPrm *prm) |
Take message system from state MSG_S_UNINITIALIZED to state MSG_S_INITIALIZED. | |
MSG_Level | MSG_getLevel (void) |
Get the current reporting level. | |
const char * | MSG_getTask (void) |
Return pointer to task name. | |
unsigned short | MSG_getTrace (void) |
Get the current trace buffer number. | |
MSG_Level | MSG_setLevel (MSG_Level level) |
Set the current reporting level. | |
MSG_Level | MSG_setLevel4Task (void **tbd, MSG_Level level) |
Set the current reporting level for an arbitrary task. | |
unsigned int | MSG_setTask (const char *task) |
Set the task name. | |
unsigned short | MSG_setTrace (unsigned short trace) |
Set the current trace buffer number. | |
unsigned int | MSG_shutdown (void) |
Take message system from state MSG_S_INITIALIZED to state MSG_S_UNINITIALIZED. | |
unsigned int | MSG_startTask (const TASK_attr *attr) |
Take message system from state MSG_S_INITIALIZED to state MSG_S_STARTED. | |
unsigned int | MSG_stopTask (void) |
Take message system from state MSG_S_STARTED to state MSG_S_INITIALIZED. |
CVS $Id: MSG_pubdefs.h,v 1.13 2005/07/16 19:46:32 apw Exp $
|
Enumerate message severity levels. Messages can have one of four severity levels defined by the creator of the message. The names are (I hope) self explanatory. |
|
Enumeration of modes in which output processors can be called. Output processors can be called in one of three modes. Note that the pointer to the message structure is only valid during a call in mode MSG_OUT_NORMAL. |
|
Attach a message output callback routine.
In the single-threaded version of MSG, the attached routines are called directly by the MSG_report() routine. In the multi-threaded version of MSG the routines are called by the message processing task. Output processing routines may only be attached/detached when the MSG system is in state MSG_S_INITIALIZED. This is true:
|
|
Configure and start the MSG task.
|
Here is the call graph for this function:
|
Return instrumentation counts since last reset.
|
Here is the call graph for this function:
|
Return instrumentation counts since message task started.
|
Here is the call graph for this function:
|
Detach a message callback routine.
Output processing routines may only be attached/detached when the MSG system is in state MSG_S_INITIALIZED. This is true
|
|
Get the current reporting level.
If called from task level, the level associated with the task is returned. If called from interrupt level, the level associated (globally) with interrupt level is returned. |
|
Return pointer to task name.
ISR> .
|
|
Get the current trace buffer number.
If called from task level, the trace buffer number associated with the task is returned. If called from interrupt level, the trace buffer number associated (globally) with interrupt level is returned. |
|
Take message system from state MSG_S_UNINITIALIZED to state MSG_S_INITIALIZED.
|
Here is the call graph for this function:
|
Set the current reporting level.
If called from task level, the level associated with the task is set and the task's previous level is returned. If called from interrupt level, the level associated (globally) with interrupt level is set and the level previously in effect at interrupt level is returned. |
|
Set the current reporting level for an arbitrary task.
|
|
Set the task name.
|
|
Set the current trace buffer number.
If called from task level, the trace buffer number associated with the task is set and the task's previous trace buffer number is returned. If called from interrupt level, the trace buffer number associated (globally) with interrupt level is set and the trace buffer number previously in effect at interrupt level is returned. |
|
Take message system from state MSG_S_INITIALIZED to state MSG_S_UNINITIALIZED.
|
|
Take message system from state MSG_S_INITIALIZED to state MSG_S_STARTED.
In single-threaded mode, MSG_startTask() does not fork a task, and all message processing is done inline with the MSG_report() call. The task attributes block is ignored. In both modes (and before the task fork in multi-threaded mode), MSG_startTask() calls each of the output processing routines in turn with a flag to indicate an inialization call. |
Here is the call graph for this function:
|
Take message system from state MSG_S_STARTED to state MSG_S_INITIALIZED.
In single-threaded mode, there is no forked task to run down. In both modes (and after the forked task has run down in multi-threaded mode), MSG_stopTask() calls each of the output processing routines in turn with a flag to indicate a cleanup call. |