EFC_fate.h File Reference

Enumerates the fate of one event. More...

Typedefs
typedef enum _EFC_FATE_K	EFC_FATE_K
	Typedef for enum _EFC_FATE_K.
typedef enum _EFC_FATE_K	EFC_fate
	Typedef for enum _EFC_FATE_K.
Enumerations
enum	_EFC_FATE_K {   EFC_FATE_K_REJECTED = -1,   EFC_FATE_K_UNDECIDED = 0,   EFC_FATE_K_ACCEPTED = 1 }
	Enumerates the fate decided on by the filter. More...
Functions
static __inline int	EFC__fateIsRejected (int status)
	Returns non-zero if the event is to be rejected.
static __inline int	EFC__fateIsUndecided (int status)
	Returns non-zero if the event is to be rejected.
static __inline int	EFC__fateIsAccepted (int status)
	Returns non-zero if the event is to be rejected.

---

Detailed Description

Enumerates the fate of one event.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: EFC_fate.h,v 1.2 2005/10/17 18:40:46 russell Exp $

---

Typedef Documentation

EFC_fate

Typedef for enum _EFC_FATE_K.

This enumerates the return values of the EFC_filter function. The values REJECTED and ACCEPTED are really only placeholders; any number < 0 constitutes a reject and any number > 0 constitutes an accept.

The UNDECIDED fate occurs on multiple packet events and the filter is unable to reach a decision until it gets more of the event.

---

Enumeration Type Documentation

enum _EFC_FATE_K

Enumerates the fate decided on by the filter.

Enumerator:

EFC_FATE_K_REJECTED	Event was rejected
EFC_FATE_K_UNDECIDED	Need the rest of the event
EFC_FATE_K_ACCEPTED	Event was accepted

---

Function Documentation

static __inline int EFC__fateIsAccepted

(

int

status

)

[static]

Returns non-zero if the event is to be rejected.

Return values:

	==	0, if the fate is not accepted
	!=	0, if the fate is accepted

Parameters:

status

The return status

static __inline int EFC__fateIsRejected

(

int

status

)

[static]

Returns non-zero if the event is to be rejected.

Return values:

	==	0, if the fate is not rejected
	!=	0, if the fate is rejected

Parameters:

status

The return status

static __inline int EFC__fateIsUndecided

(

int

status

)

[static]

Returns non-zero if the event is to be rejected.

Return values:

	==	0, if the fate is not undecided
	!=	0, if the fate is undecided

Parameters:

status

The return status