Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

wire.h File Reference


Detailed Description

#include "monitor.h"

Go to the source code of this file.

Data Structures

struct  aw_wire_keyword_s
struct  aw_wire_listobj_s
struct  aw_wire_mkhandler_args_t
struct  aw_wire_mkmonitor_args_t
struct  aw_wire_monitor_t
struct  aw_wire_obj_s
struct  aw_wire_value_s

Typedefs

typedef aw_wire_keyword_s aw_wire_keyword_t
typedef aw_wire_listobj_s aw_wire_listobj_t
typedef aw_handler_t *(* aw_wire_mkhandler_t )(aw_wire_mkhandler_args_t *)
typedef aw_wire_obj_s aw_wire_obj_t
typedef aw_wire_value_s aw_wire_value_t

Enumerations

enum  aw_wire_obj_cd_t {
  AW_WIRE_LIST_OBJ, AW_WIRE_INUMBER_OBJ, AW_WIRE_FNUMBER_OBJ, AW_WIRE_STRING_OBJ,
  AW_WIRE_EVENT_OBJ, AW_WIRE_PLOGGER_OBJ, AW_WIRE_HLOGGER_OBJ, AW_WIRE_PROBE_OBJ,
  AW_WIRE_HANDLER_OBJ
}

Functions

void aw_wire_destroy (aw_wire_monitor_t *wm)
 Stop the monitor, free all resources.

void aw_wire_free_obj (void *obj)
 Free resources associated with wire obj.

aw_wire_keyword_t * aw_wire_keyfind (const byte_t *kw, aw_wire_keyword_t *kwlist)
 Find a keyword in kw list.

aw_wire_monitor_t * aw_wire_make (aw_wire_mkmonitor_args_t *args)
 Read text from stream/file, load monitor, start monitor.

aw_wire_obj_t * aw_wire_make_handler (aw_monitor_t *mon, const byte_t *name, aw_wire_keyword_t *kwlist, FILE *message_stream)
 Make handler using name and keyword list.


Typedef Documentation

typedef struct aw_wire_keyword_s aw_wire_keyword_t
 

Holds a list of keyword/value pairs

typedef struct aw_wire_listobj_s aw_wire_listobj_t
 

Container list of objs

typedef aw_handler_t*(* aw_wire_mkhandler_t)(aw_wire_mkhandler_args_t *)
 

typedef struct aw_wire_obj_s aw_wire_obj_t
 

An object reference

typedef struct aw_wire_value_s aw_wire_value_t
 

Holds a list of values


Enumeration Type Documentation

enum aw_wire_obj_cd_t
 

Codes for the types of objects

Enumeration values:
AW_WIRE_LIST_OBJ  list of bound vars
AW_WIRE_INUMBER_OBJ  int64_t
AW_WIRE_FNUMBER_OBJ  float64_t
AW_WIRE_STRING_OBJ  byte_t *
AW_WIRE_EVENT_OBJ  ptr to event obj
AW_WIRE_PLOGGER_OBJ 
Deprecated:
ptr to logger obj
AW_WIRE_HLOGGER_OBJ  ptr to logger obj
AW_WIRE_PROBE_OBJ 
Deprecated:
ptr to probe obj
AW_WIRE_HANDLER_OBJ  ptr to handler obj


Function Documentation

void aw_wire_destroy (  aw_wire_monitor_t *  wm  ) 
 

Stop the monitor, free all resources.

Parameters:
wm wire_monitor_t to be free'd

void aw_wire_free_obj (  void *  obj  ) 
 

Free resources associated with wire obj.

Parameters:
obj Wire object

aw_wire_keyword_t* aw_wire_keyfind (  const byte_t *  kw,
aw_wire_keyword_t *  kwlist
) 
 

Find a keyword in kw list.

Parameters:
kw String to find
kwlist List to search
Returns:
Keyword struct or NULL

aw_wire_monitor_t* aw_wire_make (  aw_wire_mkmonitor_args_t *  args  ) 
 

Read text from stream/file, load monitor, start monitor.

Parameters:
args Args struct
Returns:
A wire_monitor_t object with monitor running

aw_wire_obj_t* aw_wire_make_handler (  aw_monitor_t *  mon,
const byte_t *  name,
aw_wire_keyword_t *  kwlist,
FILE *  message_stream
) 
 

Make handler using name and keyword list.

Parameters:
mon Monitor
name Name of handler
kwlist Keyword list used in constructor
message_stream Stream for errors
Returns:
A wire handler object, or NULL on error

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