DwmIpv4TcpHeader.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmIpv4TcpHeader.hh 8421 $
// @(#) $Id: DwmIpv4TcpHeader.hh 8421 2016-04-21 04:55:55Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2007, 2016
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMIPV4TCPHEADER_HH_
#define _DWMIPV4TCPHEADER_HH_

extern "C" {
  #include <sys/types.h>
  #ifdef __linux__
    #define __FAVOR_BSD 1
  #endif
  #include <netinet/tcp.h>
  #include <inttypes.h>
}

#include <cassert>

#include "DwmIpv4PacketHeader.hh"
#include "DwmBZ2Readable.hh"
#include "DwmBZ2Writable.hh"
#include "DwmGZReadable.hh"
#include "DwmGZWritable.hh"
#include "DwmReadable.hh"
#include "DwmWritable.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4TcpHeader
    : public Readable, public Writable,
      public GZReadable, public GZWritable,
      public BZ2Readable, public BZ2Writable
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader(const Ipv4PacketHeader & ipHeader);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader(const Ipv4TcpHeader & tcpHeader);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader(struct tcphdr *tcpHdr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader(const struct tcphdr & tcpHdr);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4TcpHeader & operator = (const Ipv4TcpHeader & tcpHeader);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ~Ipv4TcpHeader();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t SourcePort() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t SourcePort(uint16_t port);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t DestinationPort() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t DestinationPort(uint16_t port);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t SequenceNumber() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t SequenceNumber(uint32_t seq);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t AckNumber() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t AckNumber(uint32_t ack);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint8_t DataOffset() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint8_t DataOffset(uint8_t offset);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint8_t Flags() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint8_t Flags(uint8_t flags);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t Window() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t Window(uint16_t window);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t Checksum() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void SetChecksum(const Ipv4PacketHeader & ipHeader,
                     const std::string & data);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t UrgentPointer() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint16_t UrgentPointer(uint16_t urgent);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE *f);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t StreamedLength() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const Ipv4TcpHeader & tcpHeader) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & 
    PrintXML(std::ostream & os, const std::string & pre = "") const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint8_t *End() const;
    
  private:
    typedef struct __attribute__((packed)) {
      uint16_t   sourcePort;
      uint16_t   destinationPort;
      uint32_t   sequenceNumber;
      uint32_t   ackNumber;
#if BYTE_ORDER == LITTLE_ENDIAN
      uint8_t    _x:4,
        dataOffset:4;
#else
      uint8_t    dataOffset:4,
        _x:4;
#endif
      uint8_t    flags;
      uint16_t   window;
      uint16_t   checksum;
      uint16_t   urgentPointer;
    } Data;
    
    Data    *_data;
    uint8_t  *_options;
    bool     _ownData;
    bool     _ownOptions;
    
    void FreeOptions();
    void AllocateOptions(uint8_t len);
  };

  
}  // namespace Dwm

#endif  // _DWMIPV4TCPHEADER_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------