The Assimilation Project
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
_Frame Struct Reference

This is the base Frame class object (in-memory TLV (type, length, value)) for every general component of a packet. More...

#include <frame.h>

Collaboration diagram for _Frame:

Data Fields

AssimObj baseclass
 Base object class for our Class system. More...
 
guint16 type
 Frame Type (see Individual TLV 'Frame' data types and layouts (by TLV type) - frameformats.h ) More...
 
guint16 length
 Frame Length. More...
 
gpointer value
 Frame Value (pointer) More...
 
gsize(* dataspace )(const Frame *self)
 How much space is needed to marshall this Frame? More...
 
void(* updatedata )(Frame *self, gpointer tlvptr, gconstpointer pktend, FrameSet *fs)
 Update packet data. More...
 
gboolean(* isvalid )(const Frame *self, gconstpointer tlvptr, gconstpointer pktend)
 TRUE if TLV data looks valid... More...
 
void(* setvalue )(Frame *self, gpointer value, guint16 length, GDestroyNotify valfinal)
 member function for setting value More...
 
void(* dump )(const Frame *self, const char *prefix)
 member function for dumping Frame More...
 
GDestroyNotify valuefinalize
 method for finalizing value More...
 

Detailed Description

This is the base Frame class object (in-memory TLV (type, length, value)) for every general component of a packet.

It is an in-memory representation of Frames which might come from or go to the wire. It is the base class for all Frame class objects, and is managed by our C-Class Management system.

Definition at line 43 of file frame.h.

Field Documentation

AssimObj _Frame::baseclass
gsize(* _Frame::dataspace)(const Frame *self)

How much space is needed to marshall this Frame?

Definition at line 48 of file frame.h.

Referenced by _decode_packet_framedata_to_frameobject(), _frame_dump(), compressframe_new(), frame_append_to_frameset_packet(), frame_new(), and frameset_construct_packet().

void(* _Frame::dump)(const Frame *self, const char *prefix)

member function for dumping Frame

Definition at line 56 of file frame.h.

Referenced by frame_new(), and frameset_dump().

gboolean(* _Frame::isvalid)(const Frame *self, gconstpointer tlvptr, gconstpointer pktend)
void(* _Frame::updatedata)(Frame *self, gpointer tlvptr, gconstpointer pktend, FrameSet *fs)

Update packet data.

Definition at line 49 of file frame.h.

Referenced by compressframe_new(), frame_new(), frameset_construct_packet(), intframe_new(), seqnoframe_new(), and signframe_new().

GDestroyNotify _Frame::valuefinalize

method for finalizing value

Definition at line 57 of file frame.h.

Referenced by frame_new(), intframe_new(), and seqnoframe_new().


The documentation for this struct was generated from the following file: