---

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

Constituent: emsg_mt     Tag: i845e

---

         

---

EMSG_output.c File Reference

Routines to output processors and output processing. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "PBS/MBA.h"
#include "PBS/FPA.h"
#include "EMSG/EMSG_msgs.h"
#include "EMSG_prvdefs.h"

Include dependency graph for EMSG_output.c:

Functions
unsigned int	EMSG_attachOutputRtn (EMSG_OutputRtn **handle, EMSG_CbOutputRtn *rtn, void *prm)
	Attach a message output callback routine.
unsigned int	EMSG_detachOutputRtn (EMSG_OutputRtn *handle)
	Detach a message callback routine.
unsigned int	EMSG_outputScan (void *prm, void *hdr)
	Call back the message output processing routines.

---

Detailed Description

Routines to output processors and output processing.

This file contains all the routines needed to attach, detach and scan output processors for the message system.

Author:

A.P.Waite & Owen H Saxton

Id

EMSG_output.c,v 1.3 2007/03/07 18:08:14 saxton Exp

---

Function Documentation

unsigned int EMSG_attachOutputRtn (  EMSG_OutputRtn **  handle, EMSG_CbOutputRtn *  rtn, void *  prm )

Attach a message output callback routine. This routine attaches a message output processing routine. Each routine attached is called once when the message system is starting, once per call to EMSG_report(), and once when the message system is stopping. In the single-threaded version of MSG, the attached routines are called directly by the EMSG_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 message system is in state EMSG_S_INITIALIZED. This is true: After a (successful) call to EMSG_initialize() but before a call to EMSG_startTask() After a (successful) run-down of the MSG system initiated by a call to EMSG_stopTask() but before the next call to either EMSG_startTask() or EMSG_shutdown(). Parameters: handle  (out) Handle for identifying the callback (used to detach) rtn  (in) Routine entry point prm  (in) Routine parameter Return values: EMSG_SUCCESS  Success EMSG_BADSTATE  Cannot attach output processors in the current message state EMSG_ALOCFAIL  Cannot allocate memory for the output routine description

unsigned int EMSG_detachOutputRtn (  EMSG_OutputRtn *  handle  )

Detach a message callback routine. This routine detaches an message output processing routine. Output processing routines may only be attached/detached when the message system is in state EMSG_S_INITIALIZED. This is true: After a (successful) call to EMSG_initialize() but before a call to EMSG_startTask() After a (successful) run-down of the MSG system initiated by a call to EMSG_stopTask() but before the next call to either EMSG_startTask() or EMSG_shutdown(). Parameters: handle  (in) Handle for identifying the callback (from attach call) Return values: EMSG_SUCCESS  Success EMSG_BADSTATE  Cannot detach output processors in the current message state EMSG_OUTNTFND  Cannot find this output processor on the list

unsigned int EMSG_outputScan (  void *  prm, void *  hdr )

Call back the message output processing routines. This routine scans through attached output processors. Parameters: prm  (in) User context stored in fork control block hdr  (in) Pointer to the message (complete packet).

---