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

eventrxhandler.h File Reference


Detailed Description

The eventrxhandler listens for Aware network events on the specified port and forwards them using the event id of rx.

This is typically used to receive events from slave agents.

Wire keywords (standard handler keywords documented in Wire )

Example:
set rx create event { name: dummy priority: 1 } create handler eventrx { port: 4321 rx: $rx cycletime: 1 }

Events generated:
Event NameTypeDescription
rx all Forwarded event with new id

#include "monitor.h"
#include "wire.h"

Go to the source code of this file.

Data Structures

struct  aw_eventrxhandler_events_t
 Events generated. More...

struct  aw_eventrxhandler_options_t
 Options. More...

struct  aw_eventrxhandler_state_t
 State of handler. More...

struct  aw_eventrxhandler_t
 Eventrx handler object. More...


Enumerations

enum  aw_eventrxhandler_protocol_t { AW_EVENTRXHANDLER_PROTOCOL_UDP, AW_EVENTRXHANDLER_PROTOCOL_TCP, AW_EVENTRXHANDLER_PROTOCOL_MC }
 Type of protocol used. More...


Functions

aw_eventrxhandler_t * aw_create_eventrxhandler (const aw_eventrxhandler_events_t *events, u_int32_t port, aw_eventrxhandler_protocol_t protocol, aw_eventrxhandler_options_t *options, aw_logger_t *logger)
 Create a eventrx handler.

void aw_free_eventrxhandler (aw_eventrxhandler_t *p)
 Free handler and all associated resources.

aw_handler_t * aw_wire_eventrxhandler (aw_wire_mkhandler_args_t *args)
 Create a eventrx handler using "wire". See header doc for keyword documentation.


Enumeration Type Documentation

enum aw_eventrxhandler_protocol_t
 

Type of protocol used.

Enumeration values:
AW_EVENTRXHANDLER_PROTOCOL_UDP 
AW_EVENTRXHANDLER_PROTOCOL_TCP 
AW_EVENTRXHANDLER_PROTOCOL_MC 


Function Documentation

aw_eventrxhandler_t* aw_create_eventrxhandler (  const aw_eventrxhandler_events_t *  events,
u_int32_t  port,
aw_eventrxhandler_protocol_t  protocol,
aw_eventrxhandler_options_t *  options,
aw_logger_t *  logger
) 
 

Create a eventrx handler.

aw_create_eventrxhandler

Parameters:
events Events to generate
port Port
protocol UDP,TCP or Multicast protocol choice
options Extra settings
logger Logger object
Returns:
Handler object

void aw_free_eventrxhandler (  aw_eventrxhandler_t *  p  ) 
 

Free handler and all associated resources.

aw_free_eventrxhandler

Parameters:
p The handler

aw_handler_t* aw_wire_eventrxhandler (  aw_wire_mkhandler_args_t *  args  ) 
 

Create a eventrx handler using "wire". See header doc for keyword documentation.

aw_wire_eventrxhandler

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