The Assimilation Project
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
frameset.h File Reference

Implements minimal client-oriented Frame and Frameset capabilities. More...

#include <projectcommon.h>
#include <glib.h>
#include <assimobj.h>
#include <frame.h>
#include <signframe.h>
#include <framesettypes.h>
#include <generic_tlv_min.h>
#include <seqnoframe.h>
Include dependency graph for frameset.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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

Macros

#define FRAMESET_INITSIZE   (GENERICTLV_HDRSZ+sizeof(guint16))
 

Functions

WINEXPORT FrameSetframeset_new (guint16 frameset_type)
 Construct a new frameset of the given type. More...
 
WINEXPORT void frameset_prepend_frame (FrameSet *fs, Frame *f)
 Prepend frame to the front of the frame list. More...
 
WINEXPORT void frameset_append_frame (FrameSet *fs, Frame *f)
 Append frame to the front of the end of the frame list. More...
 
WINEXPORT void frameset_construct_packet (FrameSet *fs, SignFrame *sign, Frame *crypt, Frame *compress)
 Construct packet to go correspond to this frameset. More...
 
WINEXPORT Frameframe_new (guint16 frame_type, gsize framesize)
 Construct a new frame - allowing for "derived" frame types... More...
 
WINEXPORT guint16 frameset_get_flags (FrameSet *fs)
 Return the flags currently set on this FrameSet. More...
 
WINEXPORT guint16 frameset_set_flags (FrameSet *f, guint16 flagbits)
 Set (OR in) the given set of FrameSet flags. More...
 
WINEXPORT guint16 frameset_clear_flags (FrameSet *f, guint16 flagbits)
 Clear the given set of FrameSet flags (& ~flagbits) More...
 
WINEXPORT gpointer frame_append_to_frameset_packet (FrameSet *, Frame *, gpointer curpos)
 Append the given Frame to a FrameSet packet. More...
 
WINEXPORT void frameset_dump (const FrameSet *)
 Dump out a FrameSet. More...
 

Detailed Description

Implements minimal client-oriented Frame and Frameset capabilities.

This file contains the minimal Frameset capabilities for a client - enough for it to be able to construct, understand and validate Frames and Framesets.

This file is part of the Assimilation Project.

Author
Copyright © 2011, 2012 - Alan Robertson alanr.nosp@m.@uni.nosp@m.x.sh
The Assimilation software is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Assimilation software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the Assimilation Project software. If not, see http://www.gnu.org/licenses/

Definition in file frameset.h.

Macro Definition Documentation

#define FRAMESET_INITSIZE   (GENERICTLV_HDRSZ+sizeof(guint16))