tcp-header.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007 Georgia Tech Research Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Raj Bhattacharjea <raj.b@gatech.edu>
 */

#ifndef TCP_HEADER_H
#define TCP_HEADER_H

#include <stdint.h>
#include "ns3/header.h"
#include "ns3/tcp-option.h"
#include "ns3/buffer.h"
#include "ns3/tcp-socket-factory.h"
#include "ns3/ipv4-address.h"
#include "ns3/ipv6-address.h"
#include "ns3/sequence-number.h"

namespace ns3 {

class TcpHeader : public Header
{
public:
  TcpHeader ();
  virtual ~TcpHeader ();

  typedef std::list< Ptr<const TcpOption> > TcpOptionList; 

  friend std::ostream& operator<< (std::ostream& os, TcpHeader const & tc);

  static std::string FlagsToString (uint8_t flags, const std::string& delimiter = "|");

  void EnableChecksums (void);

//Setters

  void SetSourcePort (uint16_t port);

  void SetDestinationPort (uint16_t port);

  void SetSequenceNumber (SequenceNumber32 sequenceNumber);

  void SetAckNumber (SequenceNumber32 ackNumber);

  void SetFlags (uint8_t flags);

  void SetWindowSize (uint16_t windowSize);

  void SetUrgentPointer (uint16_t urgentPointer);

//Getters

  uint16_t GetSourcePort () const;

  uint16_t GetDestinationPort () const;

  SequenceNumber32 GetSequenceNumber () const;

  SequenceNumber32 GetAckNumber () const;

  uint8_t GetLength () const;

  uint8_t GetFlags () const;

  uint16_t GetWindowSize () const;

  uint16_t GetUrgentPointer () const;

  Ptr<const TcpOption> GetOption (uint8_t kind) const;

  const TcpOptionList& GetOptionList (void) const;

  uint8_t GetOptionLength () const;

  uint8_t GetMaxOptionLength () const;

  bool HasOption (uint8_t kind) const;

  bool AppendOption (Ptr<const TcpOption> option);

  void InitializeChecksum (const Ipv4Address &source,
                           const Ipv4Address &destination,
                           uint8_t protocol);

  void InitializeChecksum (const Ipv6Address &source,
                           const Ipv6Address &destination,
                           uint8_t protocol);

  void InitializeChecksum (const Address &source,
                           const Address &destination,
                           uint8_t protocol);

  typedef enum
  {
    NONE = 0,   
    FIN  = 1,   
    SYN  = 2,   
    RST  = 4,   
    PSH  = 8,   
    ACK  = 16,  
    URG  = 32,  
    ECE  = 64,  
    CWR  = 128  
  } Flags_t;

  static TypeId GetTypeId (void);
  virtual TypeId GetInstanceTypeId (void) const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize (void) const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);

  bool IsChecksumOk (void) const;

  friend bool operator== (const TcpHeader &lhs, const TcpHeader &rhs);

private:
  uint16_t CalculateHeaderChecksum (uint16_t size) const;

  uint8_t CalculateHeaderLength () const;

  uint16_t m_sourcePort;        
  uint16_t m_destinationPort;   
  SequenceNumber32 m_sequenceNumber;  
  SequenceNumber32 m_ackNumber;       
  uint8_t m_length;             
  uint8_t m_flags;              
  uint16_t m_windowSize;        
  uint16_t m_urgentPointer;     

  Address m_source;       
  Address m_destination;  
  uint8_t m_protocol;     

  bool m_calcChecksum;    
  bool m_goodChecksum;    

  static const uint8_t m_maxOptionsLen = 40;         
  TcpOptionList m_options;     
  uint8_t m_optionsLen;        
};

} // namespace ns3

#endif /* TCP_HEADER */