handler.h

Go to the documentation of this file.

/*
** Copyright (C) 2004 Russell Leighton
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/



#ifndef __AWHANDLER__
#define __AWHANDLER__

#include "alarm.h"

/* do not include this directly, included in monitor.h */

typedef u_int32_t aw_handlerid_t;

typedef struct {

  struct aw_handler_s *h;             /* this handler */

  aw_timestamp_t currenttime;         /* now */

  aw_timestamp_t starttime;           /* when monitor started */

  aw_event_q_t *in_q;                 /* events dispatched to this handler */

  aw_event_q_t *out_q;                /* events generated from this handler to be dispatched to other handlers */

  aw_cache_allocator_t *ef;           /* event factory to create/free events */

  byte_t *desc;                     /* text string, may be NULL */

  struct aw_monitor_s *mon;           /* monitor */

} aw_handler_args_t;

typedef enum {
  AW_HANDLER_OK,                 /* handler method ok, must be 1st! */
  AW_HANDLER_REMOVE,             /* handler method wants to be removed from monitor  */
  AW_HANDLER_RUNNING,            /* handler is currently running (perhaps in a tasklet thread) */
  AW_HANDLER_STOPPED,            /* handler is finished running */
  AW_HANDLER_NCODES              /* must be last! */
} aw_handler_code_t;


typedef struct {

  /* the run schedule for alarm */
  aw_alarm_sched_t
   sched;

  /* the alarm for scheduled actions */
  aw_alarm_t
   *alarm;

  /* reflects current state */
  aw_handler_code_t
   status;

  /* my id */
  aw_handlerid_t
   id;

  /* ptr to my handler_q */
  struct aw_handler_q_s
   *handler_q;

  /* count of registered fd callbacks */
  u_int32_t
   fd_refcount;

  /* count of registered ire callbacks */
  u_int32_t
   ire_refcount;

  /* holds any generated events */
  aw_event_q_t
   q;

} aw_handler_state_t;

typedef struct {

  aw_event_sig_t
   start,              /* handler started */
   stop;               /* handler stopped */

} aw_handler_events_t;

typedef struct aw_handler_s {

  /* internal state */
  aw_handler_state_t
   state;

  /* if non-zero means run as tasklet */
  u_int32_t
   tasklet;

  /* if non-zero means wait to process events on xaction signal */
  int32_t
   wait;

  /* each time the handler is run, should be assigned a new xactionid */
  u_int32_t
   xactionid;

  /* logger for warning/error messages */
  aw_logger_t
   *logger;

  /* generic events generated */
  aw_handler_events_t
   events;

  /* applications can use as back pointer/tag */
  union {
    void *ptr;
    int32_t tag;
  } user;

  /* 
     called when monitor is started , before start()
     to register recieving events of a particular id.

     this function should fill the <eventid> with
     the address of an event of interest and return
     non-zero.

     it should return 0 when done.

     the monitor will call this repeatedly, setting
     <index> to zero initialliy and incrementing it
     each time until zero is returned from the function
     
   */
  int32_t (*regevent)(struct aw_handler_s *h, aw_address_t *eventid, u_int32_t index);

  /* 
     called when monitor is started , before start()
     to register recieving events that *match* a 
     mask. Eventids are said to *match* if:
          (mask & eventid) == mask

     this function should fill the <maskid> with
     the address of an event of interest and return
     non-zero.

     it should return 0 when done.

     the monitor will call this repeatedly, setting
     <index> to zero initialliy and incrementing it
     each time until zero is returned from the function
     
   */
  int32_t (*regmaskevent)(struct aw_handler_s *h, aw_address_t *eventmask, u_int32_t index);

  /* called when monitor is started, may be NULL */
  aw_handler_code_t (*start)(struct aw_monitor_s *mon, struct aw_handler_s *h);

  /* called when monitor is stopped, may be NULL */
  aw_handler_code_t (*stop)(struct aw_monitor_s *mon, struct aw_handler_s *h);

  /* called when handler is removed from monitor, may be NULL */
  aw_handler_code_t (*postremove)(struct aw_monitor_s *mon, struct aw_handler_s *handler);

  /* does the event handling, likely add events to q (for self) or to hq (TO BE dispatched to handlers), may be NULL  */
  aw_handler_code_t (*handle)(aw_handler_args_t *args);

} aw_handler_t;


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

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

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


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

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



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


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

#endif

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