---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LHK / V12-0-4

Constituent: lhk     Tag: sun-gcc

---

         

---

LHK_pubdefs.h File Reference

Public definitions for the LHK package. More...

#include "CTDB/CTDB_rt.h"

Include dependency graph for LHK_pubdefs.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	LHK_L_PRM_HDRSIZ   (6)
#define	LHK_L_TLM_HDRSIZ   (14)
#define	LHK_L_TLM_PKTSIZ   (116)
Typedefs
typedef enum _LHK_PacketStatus	LHK_PacketStatus
	Typedef for enum _LHK_PacketStatus.
typedef LHK_PacketStatus	LHK_cb_Capture (void *prm, unsigned int abas, unsigned int aidx, unsigned int seq, unsigned char *out)
	Signature for an LHK routine to capture a packet.
Enumerations
enum	_LHK_PacketStatus {   LHK_PKT_TIMEOUT = CTDB_TIMEOUT,   LHK_PKT_SUCCESS = CTDB_SUCCESS }
	Enumeration of states to be returned by a packet capture routine. More...
Functions
unsigned int	LHK_definePacket (unsigned int aidx, LHK_cb_Capture rtn, void *hsk, void *dia)
	Define a packet table entry.
unsigned int	LHK_diagnosticRequest (unsigned int apid, unsigned int count, unsigned int delta)
	Cancel a diagnostic packet request.
unsigned int	LHK_initialize2 (void)
unsigned int	LHK_start2 (void)
unsigned int	LHK_scheduleGet (void)
	Identify the schedule file in use.

---

Detailed Description

Public definitions for the LHK package.

CVS $Id: LHK_pubdefs.h,v 1.3 2007/10/28 23:38:16 apw Exp $

Author:

A.P.Waite

---

Enumeration Type Documentation

enum _LHK_PacketStatus

Enumeration of states to be returned by a packet capture routine. Enumerator: LHK_PKT_TIMEOUT  Packet not created LHK_PKT_SUCCESS  Packet created

---

Function Documentation

unsigned int LHK_definePacket (  unsigned int  aidx, LHK_cb_Capture  rtn, void *  hsk, void *  dia )

Define a packet table entry. Parameters: aidx  (in) Index in APID packet table rtn  (in) Routine to capture the APID data hsk  (in) User parameter to use when capturing housekeeping dia  (in) User parameter to use when capturing diagnostic Return values: LHK_BADAIDX  Invalid APID index LHK_NULLRTN  Capture routine defined as NULL LHK_SUCCESS  Success LHK_definePacket() defines a packet entry in the APID table. The definition consists of a routine to capture the packet data, and separate user parameters for when the capture is performed in regular housekeeping mode or in demand diagnostic mode.

unsigned int LHK_diagnosticRequest (  unsigned int  aidx, unsigned int  count, unsigned int  delta )

Cancel a diagnostic packet request. Parameters: aidx  (in) Diagnostic packet APID index (repeat, index) count  (in) Number of packets to send (zero implies "forever") delta  (in) Interval between packets (milliseconds) Return values: LHK_BADAIDX  Invalid APID index LHK_DIAGTIME  Must specify a repetition time (unless count is zero) LHK_SUCCESS  Success LHK_diagnosticRequest() builds a request for a diagnostic packet, which will be queued, like a command, to the housekeeping task.

unsigned int LHK_scheduleGet (  void   )

Identify the schedule file in use. Return values: 0  Using the internal default schedule x  File ID of the schedule file in use LHK_scheduleGet() returns the file ID for the schedule file currently in use (or zero if the internal default schedule is in use).

---