mcrxhandler.h File Reference

Detailed Description

The is a multicast file receiver (rx). This is meant to be used with mctxhandler, the transmitter program. Given a mctxhandler running on the same mutlicast address, this program will receive the files sent.

This design is intended to run on LANs and typically used to share files on a cluster/grid.

The design assumes a CLEAN network, where dropped packets are very unusual. Although this program will re-send dropped packets, the performance will be adversley affected. In this design a dropped packet is considered an error. If you do see many dropped packets you can lower the tranmit rate and/or troubleshoot your network.

Wire keywords (standard handler keywords documented in Wire )

mcaddress: ip valid mutlicast ip address (optional, defaults to 224.0.0.1)
mcport: int mc port (optional, defaults to 1800)
mcinterface: interface name multicast interface (optional, defaults to ANY)
timeout: integer the time in seconds to wait idle after sending file for client re-transmit requests (optional, defaults to 1)
received: event Event to emit for each file successfully received
error: event Event to emit for each file failed to be received

Example:


  create handler mcrx { }

Events generated:

Event Name Type Description

received AW_EVENT_TYPE_STRING Was able to send file, value is file path

error AW_EVENT_TYPE_STRING Was NOT able to receive file, value is file path

Event Name	Type	Description
received	AW_EVENT_TYPE_STRING	Was able to send file, value is file path
error	AW_EVENT_TYPE_STRING	Was NOT able to receive file, value is file path

#include "monitor.h"
#include "wire.h"
#include "bitvector.h"
#include "mctxrx.h"

Go to the source code of this file.

Data Structures

struct aw_mcrxhandler_events_t

struct aw_mcrxhandler_state_t

State of handler. More...

struct aw_mcrxhandler_t

Handler object. More...

Enumerations

enum aw_mcrxhandler_state_cd_t { AW_MCRXHANDLER_IDLE, AW_MCRXHANDLER_READING, AW_MCRXHANDLER_WAIT_RETX }

The state codes for each state on handler. More...

Functions

aw_mcrxhandler_t * aw_create_mcrxhandler (const byte_t *mcaddress, u_int32_t mcport, const byte_t *mcinterface, aw_timestamp_t timeout, const aw_mcrxhandler_events_t *events, aw_logger_t *logger)

Create a mcrxhandler.

Enumeration Type Documentation

enum aw_mcrxhandler_state_cd_t

The state codes for each state on handler.

Enumeration values:

AW_MCRXHANDLER_IDLE

AW_MCRXHANDLER_READING

AW_MCRXHANDLER_WAIT_RETX

Function Documentation

aw_mcrxhandler_t* aw_create_mcrxhandler ( const byte_t * mcaddress,

u_int32_t mcport,

const byte_t * mcinterface,

aw_timestamp_t timeout,

const aw_mcrxhandler_events_t * events,

aw_logger_t * logger

)

Create a mcrxhandler.
aw_create_mcrxhandler

Parameters:

mcaddress Multicast address

mcport Multicast port

mcinterface Interface name to send multicast, may be NULL to default

timeout Time to wait idle after sending file for client re-transmit requests

events Events to send for each file

logger Logger object

Returns:
Handler object


Data Structures
struct	aw_mcrxhandler_events_t
struct	aw_mcrxhandler_state_t
	State of handler. More...
struct	aw_mcrxhandler_t
	Handler object. More...
Enumerations
enum	aw_mcrxhandler_state_cd_t { AW_MCRXHANDLER_IDLE, AW_MCRXHANDLER_READING, AW_MCRXHANDLER_WAIT_RETX }
	The state codes for each state on handler. More...
Functions
aw_mcrxhandler_t *	aw_create_mcrxhandler (const byte_t mcaddress, u_int32_t mcport, const byte_t mcinterface, aw_timestamp_t timeout, const aw_mcrxhandler_events_t events, aw_logger_t logger)
	Create a mcrxhandler.