DwmIpv4UdpPayload.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmIpv4UdpPayload.hh 8401 $
// @(#) $Id: DwmIpv4UdpPayload.hh 8401 2016-04-17 06:44:31Z 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 _DWMIPV4UDPPAYLOAD_HH_
#define _DWMIPV4UDPPAYLOAD_HH_

extern "C" {
  #include <inttypes.h>
}

#include <cassert>
#include <cstdlib>
#include <cstring>
#include <sstream>
#include <string>
#include <utility>

#include "DwmIO.hh"
#include "DwmIpv4UdpHeader.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4UdpPayload
    : public Writable, public GZWritable, public BZ2Writable
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4UdpPayload();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4UdpPayload(const Ipv4UdpHeader & udpHeader);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4UdpPayload(uint8_t *buf, uint16_t len);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4UdpPayload(const std::string & s);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ~Ipv4UdpPayload();
    
    std::pair<uint16_t,const uint8_t *> Payload() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::string ToString() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t Sum() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename T>
    bool GetPayload(T & payload) const
    {
      bool  rc = false;
      if (_payload.first) {
        std::istringstream  is(std::string((const char *)_payload.second,
                                           _payload.first));
        rc = IO::Read(is, payload);
      }
      return(rc);
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename T>
    bool SetPayload(const T & payload)
    {
      bool  rc = false;
      Free();

      uint16_t  maxPayloadLen = 65535 - (20 + 8);
      uint32_t payloadLen = IO::StreamedLength(payload);
      if (payloadLen <= maxPayloadLen) {
        std::ostringstream  os;
        if (IO::Write(os, payload)) {
          _payload.first = payloadLen;
          _payload.second = (uint8_t *)calloc(1, _payload.first);
          assert(_payload.second);
          memcpy(_payload.second, os.str().c_str(), _payload.first);
          rc = true;
        }
      }
      return(rc);
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    void Clear();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is, uint16_t len);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd, uint16_t len);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE *f, uint16_t len);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf, uint16_t len);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf, uint16_t len);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t StreamedLength() const;
    
  private:
    std::pair<uint16_t, uint8_t *>  _payload;
    bool                            _ownData;

    void Free();
    void Allocate(uint16_t len);
  };
  
}  // namespace Dwm

#endif  // _DWMIPV4UDPPAYLOAD_HH_

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