_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 )(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 42 of file frame.h.

Field Documentation

AssimObj _Frame::baseclass

Base object class for our Class system.

Definition at line 43 of file frame.h.

Referenced by _frameset_toString(), _fsprotocol_ackseqno(), _fsprotocol_xmitifwecan(), addrframe_new(), cstringframe_new(), intframe_new(), ipportframe_new(), and seqnoframe_new().

gsize(* _Frame::dataspace)(Frame *self)

How much space is needed to marshall this Frame?

Definition at line 47 of file frame.h.

Referenced by _decode_packet_framedata_to_frameobject(), 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 55 of file frame.h.

Referenced by frame_new(), and frameset_dump().

gboolean(* _Frame::isvalid)(const Frame *self, gconstpointer tlvptr, gconstpointer pktend)

TRUE if TLV data looks valid...

Definition at line 49 of file frame.h.

Referenced by address_tests(), addrframe_new(), compressframe_new(), cryptframe_new(), cstringframe_new(), frame_new(), frameset_construct_packet(), intframe_new(), ipportframe_new(), nvpairframe_new(), seqnoframe_new(), signframe_new(), and unknownframe_new().

guint16 _Frame::length

Frame Length.

Definition at line 45 of file frame.h.

Referenced by _addrframe_setaddr(), _frame_dump(), _frame_total_size(), _ipportframe_setaddr(), addrframe_tlvconstructor(), cryptframe_tlvconstructor(), cstringframe_tlvconstructor(), frame_append_to_frameset_packet(), frame_new(), frame_tlvconstructor(), frameset_construct_packet(), intframe_new(), intframe_tlvconstructor(), ipportframe_tlvconstructor(), nvpairframe_new(), nvpairframe_tlvconstructor(), seqnoframe_new(), signframe_new(), signframe_tlvconstructor(), and unknownframe_tlvconstructor().

void(* _Frame::setvalue)(Frame *self, gpointer value, guint16 length, GDestroyNotify valfinal)

member function for setting value

Definition at line 51 of file frame.h.

Referenced by cma.AssimCclasses.pyCstringFrame::__init__(), _jsondiscovery_send(), cast_frameset_tests(), construct_pcap_frameset(), create_setconfig(), cstringframe_tlvconstructor(), frame_new(), frame_tlvconstructor(), intframe_new(), nano_reqconfig(), nanoprobe_report_upstream(), nvpairframe_tlvconstructor(), seqnoframe_new(), and unknownframe_tlvconstructor().

guint16 _Frame::type

Frame Type (see Individual TLV 'Frame' data types and layouts (by TLV type) - frameformats.h )

Definition at line 44 of file frame.h.

Referenced by _frame_dump(), _frameset_getseqno(), check_JSON(), frame_append_to_frameset_packet(), frame_new(), frameset_construct_packet(), nanoobey_change_debug(), nanoobey_expecthb(), nanoobey_sendhb(), nanoobey_setconfig(), nanoobey_startdiscover(), nanoobey_stopdiscover(), nanoobey_stopexpecthb(), nanoobey_stopsendhb(), and obey_pingpong().

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

Update packet data.

Definition at line 48 of file frame.h.

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

gpointer _Frame::value

Frame Value (pointer)

Definition at line 46 of file frame.h.

Referenced by _addrframe_setaddr(), _ipportframe_setaddr(), check_JSON(), frame_append_to_frameset_packet(), frame_new(), intframe_new(), nanoobey_change_debug(), nanoobey_setconfig(), nanoobey_startdiscover(), nanoobey_stopdiscover(), seqnoframe_new(), and signframe_new().

GDestroyNotify _Frame::valuefinalize

method for finalizing value

Definition at line 56 of file frame.h.

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

---

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

• frame.h