root / otg / trunk / src / cpp / flow.h

#ifndef FLOW_H
#define FLOW_H

//#include "unixtime.h"
//#include "packet.h"
#include "address.h"
//#include <string.h>

#define MAX_PKT_PER_FLOW  65536*65536


/**
 * Flow class is used by the receiver to post-processing incoming packets, 
 * including classifying them from differnt source IP/Port..
 * It is used and controled by the Gate.
 * Flows are orginized as "link list" --- a double-link table structure. 
 * Each flow has two pointers pointing
 * to the previous and next object in the list respectively.
 */

class Flow {
  friend class Gate;
  friend class Packet;
public:
  inline Flow(int flowid):flowid_(flowid){seqno_ = 0;}
 //Packet *packetcache_;   ///< cache a packet here , only one packet pointer, not point to an array or queue.
 // Sink * sin_;    ///< each flow connects to a next-step processing entity, usually a sink.
 Flow *prev_;    ///< previous flow    
 Flow *next_;    ///< next flow
protected:
 Address *addrId_; ///< Pointer to an  address to identify this stream, distinguish this stream from others
 unsigned long seqno_;  ///< number of packets received by this flow    
 int flowid_; ///< used to identify the flow object, more like a "process tag". If an packet is tagged with the flow id, it means having been processed by this flow object. The file descriptor to receving a flow,also acting as like a flowid, useful for TCP gate.  
 //UnixTime flowclock_;
public: 
 /**
  * Function to getID 
  */
 inline int getID(){return flowid_;}
 /**
  * Function to Increment Seq No.
  */
 inline void incSeq(){
          seqno_++; 
          if(seqno_ > MAX_PKT_PER_FLOW )seqno_= 0; //FIX ME or OK??
 } 
 /**
  * Function to get the address of this stream. 
  */
inline Address* getAddr(){ return addrId_;} 
inline void setAddress(Address* src){addrId_ = src->clone();}
/**
 * Function to get the packet pointer of this stream
 *///
 //inline Packet* getPacket(){ return packetcache_;}
/**
 * Function to get the current sequence number of this stream
 */   
inline unsigned long getSeqno(){return seqno_;}
//inline void bindSink(Sink *si){ sin_ = si; }                


}; 
  
#endif