stream.h

Go to the documentation of this file.

 
#pragma once
#include <epan/tvbuff.h>
#include <epan/reassemble.h>
#include "ws_symbol_export.h"
 
struct _fragment_items;
 
/* A stream represents the concept of an arbitrary stream of data,
   divided up into frames for transmission, where the frames have
   little or no correspondence to the PDUs of the protocol being
   streamed, and those PDUs are just delineated by a magic number.
 
   For example, we stream H.223 over IAX2. IAX2 has no concept of
   H.223 PDUs and just divides the H.223 stream into 160-byte
   frames. H.223 PDUs are delineated by two-byte magic numbers (which
   may, of course, straddle an IAX2 frame boundary).
 
   Essentially we act as a wrapper to reassemble.h, by making up
   PDU ids and keeping some additional data on fragments to allow the
   PDUs to be defragmented again.
*/
 
 
/* A stream_t represents a stream. There might be one or two streams
   in a circuit, depending on whether that circuit is mono- or bi-directional.
*/
typedef struct stream stream_t;
 
/* Fragments in a PDU are represented using a stream_pdu_fragment_t,
   and placed in a linked-list with other fragments in the PDU.
 
   (They're also placed in a hash so we can find them again later)
*/
typedef struct stream_pdu_fragment stream_pdu_fragment_t;
 
 
struct conversation;
 
WS_DLL_PUBLIC stream_t *stream_new ( const struct conversation *conv, int p2p_dir );
 
WS_DLL_PUBLIC stream_t *find_stream ( const struct conversation *conv, int p2p_dir );
 
 
 
WS_DLL_PUBLIC stream_pdu_fragment_t *stream_find_frag( stream_t *stream, uint32_t framenum, uint32_t offset );
 
WS_DLL_PUBLIC stream_pdu_fragment_t *stream_add_frag( stream_t *stream, uint32_t framenum, uint32_t offset,
                    tvbuff_t *tvb, packet_info *pinfo, bool more_frags );
 
extern uint32_t stream_get_frag_length( const stream_pdu_fragment_t *frag);
 
WS_DLL_PUBLIC fragment_head *stream_get_frag_data( const stream_pdu_fragment_t *frag);
 
WS_DLL_PUBLIC tvbuff_t *stream_process_reassembled(
    tvbuff_t *tvb, int offset, packet_info *pinfo,
    const char *name, const stream_pdu_fragment_t *frag,
    const struct _fragment_items *fit,
    bool *update_col_infop, proto_tree *tree);
 
extern uint32_t stream_get_pdu_no( const stream_pdu_fragment_t *frag);
 
void stream_init( void );
 
void stream_cleanup( void );