handler.h File Reference

---

Detailed Description

An aware handler registers to receive events and may itself generate events. Handlers do such things as compute statistics, filter events, send warning messages and execute commands.

#include "alarm.h"

Go to the source code of this file.

Data Structures
struct	aw_handler_args_t
struct	aw_handler_events_t
	Events generated. More...
struct	aw_handler_s
struct	aw_handler_state_t
Typedefs
typedef aw_handler_s	aw_handler_t
typedef u_int32_t	aw_handlerid_t
Enumerations
enum	aw_handler_code_t {   AW_HANDLER_OK, AW_HANDLER_REMOVE, AW_HANDLER_RUNNING, AW_HANDLER_STOPPED,   AW_HANDLER_NCODES }
Functions
void	aw_handler_append_outq (aw_event_t *e, aw_event_t *te, aw_handler_args_t *args)
	Send event to handlers.
void	aw_handler_float32_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, float32_t val)
	Send float32 event to handlers.
void	aw_handler_float64_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, float64_t val)
	Send float64 event to handlers.
void	aw_handler_int32_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, u_int32_t val)
	Send int32 event to handlers.
void	aw_handler_int64_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, u_int64_t val)
	Send int64 event to handlers.
void	aw_handler_string_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, byte_t *val, int32_t dup)
	Send string event to handlers, NOTE: this will free the string later!
void	aw_handler_timestamp_event (aw_handler_args_t *args, aw_event_t *trigger_event, aw_event_sig_t *event_sig, aw_timestamp_t val)
	Send timestamp event to handlers.

---

Typedef Documentation

typedef struct aw_handler_s aw_handler_t

Handler object

typedef u_int32_t aw_handlerid_t

Cookie for handler, returned from aw_add_handler(), used in aw_remove_handler()

---

Enumeration Type Documentation

enum aw_handler_code_t

Handler return/state codes. NOTE the following state transition table: State Next State Action on change AW_HANDLER_OK AW_HANDLER_REMOVE Stop and remove handler AW_HANDLER_OK AW_HANDLER_RUNNING Handler CAN receive IRE and FD callbacks events but not events from other handlers AW_HANDLER_RUNNING AW_HANDLER_STOPPED Generated events are collected and state set to AW_HANDLER_OK Enumeration values: AW_HANDLER_OK  AW_HANDLER_REMOVE  AW_HANDLER_RUNNING  AW_HANDLER_STOPPED  AW_HANDLER_NCODES

---

Function Documentation

void aw_handler_append_outq (  aw_event_t *  e, aw_event_t *  te, aw_handler_args_t *  args )

Send event to handlers. aw_handler_append_outq Parameters: e  Event ptr te  Triggering event (may be NULL) args  Handler args

void aw_handler_float32_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, float32_t  val )

Send float32 event to handlers. aw_handler_float32_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  Value

void aw_handler_float64_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, float64_t  val )

Send float64 event to handlers. aw_handler_float64_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  Value

void aw_handler_int32_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, u_int32_t  val )

Send int32 event to handlers. aw_handler_int32_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  Value

void aw_handler_int64_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, u_int64_t  val )

Send int64 event to handlers. aw_handler_int64_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  Value

void aw_handler_string_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, byte_t *  val, int32_t  dup )

Send string event to handlers, NOTE: this will free the string later! aw_handler_string_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  String value dup  If non-zero strdup() string inside function. Usually you want this.

void aw_handler_timestamp_event (  aw_handler_args_t *  args, aw_event_t *  trigger_event, aw_event_sig_t *  event_sig, aw_timestamp_t  val )

Send timestamp event to handlers. aw_handler_timestamp_event Parameters: args  Handler args trigger_event  Event that is triggering this event (may be NULL) event_sig  Event signature val  Value

Aware 0.11.1 Copyright (C) 1998-2005 Russell Leighton (russ@elegant-software.com)