---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > EMSG / V0-0-3

Constituent: emsg_mt     Tag: i845e

---

         

---

EMSG_report_mt.c File Reference

Multi-threaded specific implementations of utility routines. More...

#include "IPBS/MBA.h"
#include "EMSG/EMSG_msgs.h"
#include "EMSG_prvdefs.h"

Include dependency graph for EMSG_report_mt.c:

Functions
EMSG_Level	EMSG_getLevel ()
	Get the current reporting level.
const char *	EMSG_getTask ()
	Return pointer to task name.
unsigned short	EMSG_getTrace ()
	Get the current trace buffer number.
unsigned int	EMSG_isDrained (EMSG_Control *mcb)
	Test to see if the fork has drained.
EMSG_Level	EMSG_setLevel (EMSG_Level newval)
	Set the current reporting level.
EMSG_Level	EMSG_setLevel4Task (int tid, EMSG_Level newval)
	Set the current reporting level for an arbitrary task.
unsigned int	EMSG_setTask (const char *task)
	Set the task name.
unsigned short	EMSG_setTrace (unsigned short newval)
	Set the current trace buffer number.
void	EMSG_deleteOptions (void)
	Delete task options.

---

Detailed Description

Multi-threaded specific implementations of utility routines.

Author:

A.P.Waite & Owen H Saxton

Id

EMSG_report_mt.c,v 1.3 2007/03/07 18:08:27 saxton Exp

---

Function Documentation

void EMSG_deleteOptions (  void   )

Delete task options. This routine deletes the options block associated with the current task. It should be called by any task using the message system just before the task exits.

EMSG_Level EMSG_getLevel (  void   )

Get the current reporting level. This routine returns the level at which messages are reported. Messages whose severity is greater than or equal to the level set are reported. 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. Returns: The severity level for reporting

const char* EMSG_getTask (  void   )

Return pointer to task name. This routine returns a pointer to the task name. Returns: Pointer to the string containing the task name

unsigned short EMSG_getTrace (  void   )

Get the current trace buffer number. This routine returns the trace buffer number currently in effect. This is a 16-bit number associated with a message. All messages record the current value of the trace buffer number. This is a simple mechanism to group messages. 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. Returns: The trace buffer number for reporting

unsigned int EMSG_isDrained (  EMSG_Control *  mcb  )

Test to see if the fork has drained. Parameters: mcb  Message control block Return values: 0  Fork is not drained 1  Fork is drained

EMSG_Level EMSG_setLevel (  EMSG_Level  newval  )

Set the current reporting level. This routine sets the level at which messages are reported. A message whose severity is greater than or equal to the set level is reported. This routine returns the reporting level prior to the call (to allow simple reversion). 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. Parameters: newval  (in) Reporting level to be set Returns: Reporting level prior to the call

EMSG_Level EMSG_setLevel4Task (  int  tid, EMSG_Level  newval )

Set the current reporting level for an arbitrary task. This routine sets the level at which messages are reported for an arbitrary task. Similar in function to EMSG_setLevel(), but... Warning: This routine has no way to validate the authenticity of the task ID. The calling routine is responsible for ensuring integrity. Parameters: tid  (in) Arbitrary task's ID newval  (in) Reporting level to be set Returns: Reporting level prior to the call

unsigned int EMSG_setTask (  const char *  task  )

Set the task name. This routine sets a task name. This is only valid in the single- threaded environment where the task name is an arbitrary string under user control. It makes no sense to call this routine for multi- threaded systems so this multi-threaded implementation simply ignores the call. Parameters: task  (in) Pointer to task name Return values: EMSG_SUCCESS  Always

unsigned short EMSG_setTrace (  unsigned short  newval  )

Set the current trace buffer number. This routine sets the trace buffer number currently in effect. This is a 16-bit number associated with a message. All messages record the current value of the trace buffer number. This is a simple mechanism to group messages. The routine returns the trace buffer in effect prior to the call to make reversion simple. 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. Parameters: newval  (in) Trace buffer number to set Returns: The trace buffer prior to the change

---