PacketParser.cci

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


/** \file
    \brief PacketParser inline non-template implementation */

// Custom includes
#include <iterator>
#include "PacketData.hh"

#define prefix_ inline
//-/////////////////////////////////////////////////////////////////////////////////////////////////

//-/////////////////////////////////////////////////////////////////////////////////////////////////
// senf::PacketParserBase

// public members

prefix_ senf::PacketParserBase::data_iterator senf::PacketParserBase::i()
    const
{
    return i_;
}

// private members

prefix_ senf::PacketParserBase::data_iterator senf::PacketParserBase::end()
    const
{
    return data_->end();
}

prefix_ senf::PacketParserBase::ParserProtector::ParserProtector(PacketParserBase const * p)
    : safe_i_( *p), parser_(p)
{}

prefix_ senf::PacketParserBase::ParserProtector::ParserProtector(ParserProtector const & other_)
    : safe_i_( *other_.parser_), parser_(other_.parser_)
{
    other_.parser_ = nullptr;
}

prefix_ senf::PacketParserBase::ParserProtector::~ParserProtector()
{
    if (parser_) const_cast<PacketParserBase *>(parser_)->i_ = safe_i_;
}

// protected members

prefix_ senf::PacketParserBase::ParserProtector senf::PacketParserBase::protect()
    const
{
    return ParserProtector(this);
}

prefix_ bool senf::PacketParserBase::check(size_type size)
    const
{
    return std::distance(i(),end()) < 0 ? false : size <= size_type(std::distance(i(),end()));
}

prefix_ void senf::PacketParserBase::validate(size_type size)
   const
{
    if (SENF_UNLIKELY(!check(size)))
        throw TruncatedPacketException();
}

prefix_ senf::PacketParserBase::PacketParserBase(data_iterator i, state_type s)
    : i_ (i), data_ (s)
{}

prefix_ senf::PacketParserBase::PacketParserBase(data_iterator i, state_type s,
                                                 size_type size)
    : i_ (i), data_ (s)
{
    validate(size);
}

// public members

prefix_ senf::PacketParserBase::data_iterator senf::PacketParserBase::i(size_type offset)
    const
{
    validate(offset);
    return boost::next(i_, offset);
}

prefix_ senf::PacketParserBase::state_type senf::PacketParserBase::state()
    const
{
    return data_;
}

prefix_ senf::PacketData & senf::PacketParserBase::data()
    const
{
    return * data_;
}

prefix_ void senf::PacketParserBase::init()
    const
{}

prefix_ void senf::PacketParserBase::defaultInit()
    const
{}

prefix_ senf::Packet senf::PacketParserBase::packet()
    const
{
    // OUCH ... I hate this but for some awkward packet types, access to the packet
    // from the parser is really needed (e.g. UDP when building the pseudo-header
    // for calculating the checksum).
    return Packet(PacketInterpreterBase::ptr(static_cast<PacketInterpreterBase*>(&data())));
}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#undef prefix_


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: