EMSG_prvdefs.h File Reference

Private definitions for the EMSG facility. More...

#include <EMSG/EMSG_pubdefs.h>
#include <EMSG/EMSG_database.h>
#include <PBS/FPA.h>

Classes
struct	_EMSG_Packet
	Structure to hold a complete message description packet. More...
struct	_EMSG_OutputRtn
	Structure to hold an output processor (on a singly linked list). More...
struct	_EMSG_TaskOption
struct	_EMSG_AltMessage
	Alternative message table (used to improve internal efficiency). More...
struct	_EMSG_Control
	Structure to hold the message control block. More...
Defines
#define	EMSG_L_TSKNAME   16
	Maximum length of task name (incl.
#define	EMSG_L_RTNNAME   32
	Maximum length of routine name (incl.
#define	EMSG_D_TRACE   0
	Default trace buffer number.
#define	EMSG_D_LEVEL   0
	Default reporting level.
#define	EMSG_P_RESERVED   2
	Packets reserved for blackout processing.
#define	EMSG_A_UNKNOWNS   0
	Indices into the MSG_alt[] table.
#define	EMSG_A_UNKNOWNW   1
	Unknown code (severity "warning").
#define	EMSG_A_UNKNOWNI   2
	Unknown code (severity "information").
#define	EMSG_A_UNKNOWNE   3
	Unknown code (severity "error").
#define	EMSG_A_UNIXGOOD   4
	Unknown code (suspect Unix "good").
#define	EMSG_A_UNIXEROR   5
	Unknown code (suspect Unix "error").
#define	EMSG_A_GAPBEGIN   6
	Begin blackout message.
#define	EMSG_A_GAPEND   7
	End blackout message.
#define	EMSG_L_ALTERNATE   8
	Number of alternate messages.
#define	EMSG_RW_DECLARE(key)
	Declare an interlock key.
#define	EMSG_RW_LOCK(key)
	Take an interlock.
#define	EMSG_RW_UNLOCK(key)
	Free an interlock.
#define	EMSG_MX_LOCK(mtx)
	Take a mutex.
#define	EMSG_MX_UNLOCK(mtx)
	Free a mutex.
Typedefs
typedef enum _EMSG_States	EMSG_States
	Enumeration of states the message system can be in.
typedef struct _EMSG_Packet	EMSG_Packet
	Structure to hold a complete message description packet.
typedef struct _EMSG_TaskOption	EMSG_TaskOption
	Per task reporting level and trace buffer options.
typedef struct _EMSG_AltMessage	EMSG_AltMessage
	Alternative message table (used to improve internal efficiency).
typedef struct _EMSG_Control	EMSG_Control
	Structure to hold the message control block.
Enumerations
enum	_EMSG_States {   EMSG_S_NOWHERE = 0,   EMSG_S_UNINITIALIZED = 1,   EMSG_S_INITIALIZED = 2,   EMSG_S_STARTED = 3,   EMSG_S_STOPPING = 4,   EMSG_S_STOPSYNC = 5 }
	Enumeration of states the message system can be in. More...
Functions
unsigned int	EMSG_getCtlThread (void)
void	EMSG_getIP (unsigned char)
unsigned int	EMSG_outputScan (void *prm, void *hdr)
	Call back the message output processing routines.
Variables
EMSG_AltMessage	EMSG_alt [EMSG_L_ALTERNATE]
	Translation table for the eight "special" messages.
EMSG_Control *	EMSG_mcb
	Pointer to the control block for the message system.

---

Detailed Description

Private definitions for the EMSG facility.

Author:

A.P.Waite & Owen H Saxton

Id

EMSG_prvdefs.h,v 1.4 2011/03/25 21:37:59 saxton Exp

---

Define Documentation

#define EMSG_A_UNKNOWNS   0

Indices into the MSG_alt[] table.

The first four entries must be aligned with the message severity codes (which are in an awkward order). This allows the severity code to be used as an index into this table. Unknown code (severity "success")

#define EMSG_L_RTNNAME   32

Maximum length of routine name (incl.

\0)

#define EMSG_L_TSKNAME   16

Maximum length of task name (incl.

\0)

Referenced by EMSG_outputScan(), and EMSG_setTask().

---

Typedef Documentation

typedef enum _EMSG_States EMSG_States

Enumeration of states the message system can be in.

Reflects the current state of the message system. Used internally to keep the state diagram straight.

---

Enumeration Type Documentation

enum _EMSG_States

Enumeration of states the message system can be in.

Reflects the current state of the message system. Used internally to keep the state diagram straight.

Enumerator:

EMSG_S_NOWHERE	Before first initialization call.
EMSG_S_UNINITIALIZED	Uninitialized.
EMSG_S_INITIALIZED	Initialized.
EMSG_S_STARTED	Normal operations.
EMSG_S_STOPPING	Stop request queued to MSG task.
EMSG_S_STOPSYNC	Stop request seen in MSG task.

---

Function Documentation

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).

References _EMSG_Control::acb, _EMSG_Control::beg, _EMSG_Packet::buf, _EMSG_AltMessage::code, _EMSG_Message::code, _EMSG_Control::drp, EMSG_A_GAPEND, EMSG_alt, EMSG_getTask(), EMSG_getTrace(), EMSG_K_FMT4BYTE, EMSG_K_FMT8BYTE, EMSG_K_FMTBITS, EMSG_K_FMTSTATUS, EMSG_K_FMTSTRING, EMSG_K_SEVERITY, EMSG_L_FMTLENGTH, EMSG_L_TSKNAME, EMSG_M_FMTBITS, EMSG_M_SEVERITY, EMSG_mcb, EMSG_OUT_NORMAL, EMSG_RW_DECLARE, EMSG_RW_LOCK, EMSG_RW_UNLOCK, EMSG_S_STOPSYNC, EMSG_V_SEVERITY, _EMSG_Control::end, _EMSG_Message::fac, _EMSG_MsgList::frmt, _EMSG_Counts::hwm, _EMSG_Message::isr, _EMSG_Packet::msg, _EMSG_MsgList::name, _EMSG_OutputRtn::next, _EMSG_Message::nick, _EMSG_Control::now, _EMSG_Control::out, _EMSG_Control::pkt_len, _EMSG_OutputRtn::prm, _EMSG_Control::reset, _EMSG_OutputRtn::rtn, _EMSG_Message::rtn, _EMSG_FacList::sdb, _EMSG_Counts::sent, _EMSG_Message::sev, _EMSG_Control::start, _EMSG_Control::state, _EMSG_Message::task, _EMSG_Message::text, _EMSG_Message::tid, _EMSG_Message::time, and _EMSG_Message::trace.

Referenced by EMSG_report().

---

Variable Documentation

EMSG_Control* EMSG_mcb

Pointer to the control block for the message system.

Referenced by EMSG_attachOutputRtn(), EMSG_detachOutputRtn(), EMSG_outputScan(), and EMSG_report().