corsaro_int.h File Reference

Header file dealing with the internal corsaro functions. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	corsaro_header
	Structure representing a corsaro file header. More...
struct	corsaro_trailer
	Structure representing a corsaro file trailer. More...
struct	corsaro_interval
	Structure representing the start or end of an interval. More...
struct	corsaro_plugin_data
	Structure representing the start or end of a plugin data block. More...
struct	corsaro_packet_state
	Corsaro state for a packet. More...
struct	corsaro_packet
	A lightweight wrapper around a libtrace packet. More...
struct	corsaro
	Corsaro output state. More...
struct	corsaro_in
	Corsaro input state. More...
struct	corsaro_in_record
	A reusable opaque structure for corsaro to read an input record into. More...

Macros
#define	DEPRECATED
#define	SIMPLE_FUNCTION
#define	UNUSED
#define	PRINTF(formatpos, argpos)
#define	CORSARO_INTERVAL_DEFAULT   60
	The interval after which we will end an interval.
#define	LT_PKT(corsaro_packet)   (corsaro_packet->ltpacket)
	Convenience macro to get to the libtrace packet inside an corsaro packet.
#define	CORSARO_IN_RECORD_DEFAULT_BUFFER_LEN   LIBTRACE_PACKET_BUFSIZE+1024
	The initial buffer size in the record object.

Typedefs
typedef struct corsaro_packet_state	corsaro_packet_state_t
	Corsaro state for a packet.

Enumerations
enum	{ CORSARO_PACKET_STATE_FLAG_BACKSCATTER = 0x01 }
	The possible packet state flags. More...

Corsaro data structures
These data structures are used when reading corsaro files with libcorsaro
#define	PACKED
enum	corsaro_magic {   CORSARO_MAGIC = 0x45444752, CORSARO_MAGIC_HEADER = 0x48454144, CORSARO_MAGIC_INTERVAL = 0x494E5452, CORSARO_MAGIC_DATA = 0x44415441,   CORSARO_MAGIC_TRAILER = 0x464F4F54 }
	Enum of overall corsaro magic numbers. More...
typedef enum corsaro_magic	corsaro_magic_t
	Enum of overall corsaro magic numbers.
struct corsaro_header	PACKED

---

Detailed Description

Header file dealing with the internal corsaro functions.

Author:

Alistair King

Definition in file corsaro_int.h.

---

Macro Definition Documentation

#define CORSARO_IN_RECORD_DEFAULT_BUFFER_LEN   LIBTRACE_PACKET_BUFSIZE+1024

The initial buffer size in the record object.

Definition at line 298 of file corsaro_int.h.

Referenced by corsaro_in_alloc_record().

#define CORSARO_INTERVAL_DEFAULT   60

The interval after which we will end an interval.

Definition at line 178 of file corsaro_int.h.

#define LT_PKT

(

corsaro_packet

)

(corsaro_packet->ltpacket)

Convenience macro to get to the libtrace packet inside an corsaro packet.

Definition at line 211 of file corsaro_int.h.

Referenced by corsaro_dos_process_packet().

---

Typedef Documentation

typedef enum corsaro_magic corsaro_magic_t

Enum of overall corsaro magic numbers.

typedef struct corsaro_packet_state corsaro_packet_state_t

Corsaro state for a packet.

This is passed, along with the packet, to each plugin. Plugins can add data to it, or check for data from earlier plugins. Currently, this is used to filter packets based on criteria determined by an earlier plugin

---

Enumeration Type Documentation

anonymous enum

The possible packet state flags.

Definition at line 196 of file corsaro_int.h.

enum corsaro_magic

Enum of overall corsaro magic numbers.

Enumerator:

CORSARO_MAGIC	Overall corsaro magic number - "EDGR".
CORSARO_MAGIC_HEADER	corsaro header magic number - "HEAD"
CORSARO_MAGIC_INTERVAL	corsaro interval magic number - "INTR"

Definition at line 67 of file corsaro_int.h.