_FrameSet Struct Reference

FrameSet class - used for collecting Frames when not on the wire, and for marshalling/demarshalling them for/from the wire. More...

#include <frameset.h>

Collaboration diagram for _FrameSet:

Data Fields
AssimObj	baseclass
GSList *	framelist
	List of frames in this FrameSet. More...
gpointer	packet
	Pointer to packet (when constructed) More...
gpointer	pktend
	Last byte past the end of the packet. More...
guint16	fstype
	Type of frameset. More...
guint16	fsflags
	Flags for frameset. More...
SeqnoFrame *	_seqframe
	sequence number for this frameset More...
SeqnoFrame *(*	getseqno )(FrameSet *)
	Return the sequence number for this frameset (if any) More...

Detailed Description

FrameSet class - used for collecting Frames when not on the wire, and for marshalling/demarshalling them for/from the wire.

There are a few "special" frames that have to appear first, and in a certain order. These frames have their values computed based on the values of the frames which follow them in the framelist. Some of them (notably encryption) can restructure and modify the packet contents which follow them. This is managed by our C-Class Management system.

Definition at line 43 of file frameset.h.

Field Documentation

SeqnoFrame* _FrameSet::_seqframe

sequence number for this frameset

Definition at line 51 of file frameset.h.

Referenced by _fsqueue_enq(), and _fsqueue_inqsorted().

AssimObj _FrameSet::baseclass

Definition at line 44 of file frameset.h.

Referenced by _authlistener_got_frameset(), _fsproto_fsa(), _fsprotocol_read(), _fsprotocol_receive(), _fsprotocol_xmitifwecan(), _fsqueue_enq(), _fsqueue_flush(), _fsqueue_inqsorted(), _fsqueue_toString(), _reliableudp_ackmessage(), _reliableudp_sendareliablefs(), frameset_new(), gotnetpkt(), and obey_pingpong().

GSList* _FrameSet::framelist

List of frames in this FrameSet.

Todo:

figure out if GSlist or GQueue is better...

Definition at line 45 of file frameset.h.

Referenced by _frameset_finalize(), check_JSON(), frameset_append_frame(), frameset_construct_packet(), frameset_dump(), frameset_new(), frameset_prepend_frame(), nanoobey_cancelrscoperation(), nanoobey_change_debug(), nanoobey_dorscoperation(), nanoobey_expecthb(), nanoobey_sendhb(), nanoobey_setconfig(), nanoobey_startdiscover(), nanoobey_stopdiscover(), nanoobey_stopexpecthb(), nanoobey_stopsendhb(), and obey_pingpong().

guint16 _FrameSet::fsflags

Flags for frameset.

Definition at line 50 of file frameset.h.

Referenced by frameset_clear_flags(), frameset_construct_packet(), frameset_get_flags(), frameset_new(), and frameset_set_flags().

guint16 _FrameSet::fstype

Type of frameset.

Definition at line 49 of file frameset.h.

Referenced by _authlistener_got_frameset(), _fsprotocol_receive(), _fsprotocol_send(), _netgsource_dispatch(), check_JSON(), frameset_construct_packet(), frameset_new(), gotnetpkt(), nanoobey_sendexpecthb(), and obey_pingpong().

SeqnoFrame*(* _FrameSet::getseqno)(FrameSet *)

Return the sequence number for this frameset (if any)

Definition at line 52 of file frameset.h.

Referenced by _fsproto_fsa(), _fsprotocol_ackmessage(), _fsprotocol_auditiready(), _fsprotocol_findbypkt(), _fsprotocol_read(), _fsprotocol_receive(), _fsprotocol_xmitifwecan(), _fsqueue_ackthrough(), _fsqueue_flush(), _fsqueue_inqsorted(), and frameset_new().

gpointer _FrameSet::packet

Pointer to packet (when constructed)

Definition at line 47 of file frameset.h.

Referenced by _frameset_finalize(), _netio_sendaframeset(), _netio_sendframesets(), frame_append_to_frameset_packet(), frameset_construct_packet(), and frameset_new().

gpointer _FrameSet::pktend

Last byte past the end of the packet.

Definition at line 48 of file frameset.h.

Referenced by _frameset_finalize(), _netio_sendaframeset(), _netio_sendframesets(), frame_append_to_frameset_packet(), frameset_construct_packet(), and frameset_new().

---

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

• frameset.h