downstreampacket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014,2016,2018 - Adjacent Link LLC, Bridgewater,
 * New Jersey
 * Copyright (c) 2008-2011 - DRS CenGen, LLC, Columbia, Maryland
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * 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.
 * * Neither the name of DRS CenGen, LLC nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMANEDOWNSTREAMPACKET_HEADER_
#define EMANEDOWNSTREAMPACKET_HEADER_

#include "emane/packetinfo.h"
#include "emane/serializable.h"
#include "emane/utils/vectorio.h"

#include <memory>

namespace EMANE
{
  class Event;

  class DownstreamPacket
  {
  public:
    DownstreamPacket(const PacketInfo & info, const void * buf, size_t size);

    DownstreamPacket(const DownstreamPacket &);

    DownstreamPacket & operator=(const DownstreamPacket & pkt);

    DownstreamPacket(DownstreamPacket && pkt);

    DownstreamPacket & operator=(DownstreamPacket && pkt);

    ~DownstreamPacket();

    void prepend(const void * buf, size_t size);

    void prependLengthPrefixFraming(std::uint16_t u16Length);

    void prependLengthPrefixFramingLong(std::uint32_t u32Length); 

    Utils::VectorIO getVectorIO() const;

    size_t length() const;

    const PacketInfo & getPacketInfo() const;

    void attachEvent(NEMId nemId, const Event & event);

    using EventSerializations =
      std::list<std::tuple<EMANE::NEMId,EMANE::EventId, Serialization>>;

    const EventSerializations & getEventSerializations() const;

  private:
    class Implementation;
    std::unique_ptr<Implementation> pImpl_;
  };
}

#endif // EMANEDOWNSTREAMPACKET_HEADER_