perf_pkt4.h 5.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
// Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.

#ifndef __PERF_PKT4_H
#define __PERF_PKT4_H

#include <time.h>
#include <boost/shared_ptr.hpp>
#include <dhcp/pkt4.h>

#include "localized_option.h"

namespace isc {
namespace perfdhcp {

/// \brief PerfPkt4 (DHCPv4 packet)
///
29 30 31 32 33 34 35 36 37 38 39 40 41
/// This class extends the functionality of \ref isc::dhcp::Pkt4 by adding the
/// ability to specify an options offset in the DHCP message and to override
/// options' contents.  This is particularly useful when we create a packet
/// object using a template file (i.e. do not build it dynamically). The client
/// class should read data from the template file and pass it to this class in
/// a buffer.
///
/// The contents of such a packet can be later partially replaced, notably the
/// selected options and the transaction ID.  (The transaction ID and its
/// offset in the template file are passed via the constructor.)
///
/// In order to replace contents of the options, the client class has to
/// create a collection of \ref LocalizedOption, adding them using
42
/// \ref dhcp::Pkt4::addOption.
43
///
44
/// \note If you don't use template files simply use constructors
45
/// inherited from parent class and isc::dhcp::Option type instead
46

47 48 49 50 51 52
class PerfPkt4 : public dhcp::Pkt4 {
public:

    /// Localized option pointer type.
    typedef boost::shared_ptr<LocalizedOption> LocalizedOptionPtr;

53 54
    /// \brief Constructor, used for outgoing and incoming messages
    ///
55
    /// This constructor initializes the transaction ID and
56 57 58 59 60 61 62
    /// transaction id offset of the packet with default
    /// values.
    ///
    /// \param buf buffer holding contents of the message.
    /// \param len length of the data in the buffer.
    PerfPkt4(const uint8_t* buf, size_t len);

63 64
    /// \brief Constructor, used for outgoing DHCP messages.
    ///
65 66 67 68
    /// Creates new DHCPv4 message using the provided buffer.  The
    /// transaction ID and its offset are specified via this
    /// constructor. The transaction ID is stored in the outgoing message
    /// when the client class calls \ref PerfPkt4::rawPack.
69 70
    ///
    /// \note This constructor should be used only for outgoing
71
    /// messages that are created from template files.
72
    ///
73
    /// \param buf buffer holding contents of the message (this can
74 75 76 77 78
    /// be directly read from template file).
    /// \param len length of the data in the buffer.
    /// \param transid_offset transaction id offset in outgoing message.
    /// \param transid transaction id to be stored in outgoing message.
    PerfPkt4(const uint8_t* buf,
79
             size_t len,
80 81 82 83 84
             size_t transid_offset,
             uint32_t transid);

    /// Constructor, used for incoming DHCP messages.
    ///
85 86 87 88
    /// Creates new DHCPv4 message using the provided buffer.
    /// The client class may indicate which options are to be read
    /// from the buffer. Such options should be added to the
    /// options collection using \ref dhcp::Pkt4::addOption: these
89
    /// options should be of \ref LocalizedOption class.
90
    ///
91 92 93
    /// The transaction ID offset points to the location where the
    /// transaction ID field is stored. The transaction ID will
    /// be read from this location when \ref PerfPkt4::rawUnpack is
94 95
    /// called. The transid_ class member will be updated accordingly.
    ///
96 97 98 99
    /// \note Use this constructor only in the case where you want to create
    /// an incoming DHCPv4 object from the raw buffer
    /// and you know the options offsets. The options offsets are
    /// specified on the perfdhcp command line by the user.
100 101 102 103 104
    ///
    /// \param buf pointer to a buffer of received packet content.
    /// \param len size of buffer of packet content.
    /// \param transid_offset transaction id offset in a message.
    PerfPkt4(const uint8_t* buf,
105
             size_t len,
106 107 108 109
             size_t transid_offset);

    /// \brief Returns transaction id offset in packet buffer
    ///
110
    /// \return Transaction ID offset in packet buffer
111 112
    size_t getTransIdOffset() const { return transid_offset_; };

113
    /// \brief Prepares on-wire format from raw buffer.
114
    ///
115 116
    /// The method copies the buffer provided in the constructor to the
    /// output buffer and replaces the transaction ID and selected
117
    /// options with new data.
118
    ///
119
    /// \note Use this method to prepare an on-wire DHCPv4 message
120 121 122
    /// when you use template packets that require replacement
    /// of selected options' contents before sending.
    ///
123
    /// \return false ID pack operation failed.
124 125 126
    bool rawPack();

    /// \brief Handles limited binary packet parsing for packets with
127
    /// custom offsets of options and transaction ID
128
    ///
129 130
    /// This method handles the parsing of packets that have custom offsets
    /// of options or transaction ID. Use
131
    /// \ref isc::dhcp::Pkt4::addOption to specify which options to parse.
132
    /// Options should be of the \ref isc::perfdhcp::LocalizedOption
133 134
    /// type with offset values provided. Each added option will
    /// be updated with actual data read from the binary packet buffer.
135
    ///
136
    /// \return false If unpack operation failed.
137 138 139 140 141 142 143 144 145 146 147
    bool rawUnpack();

private:
    size_t transid_offset_;      ///< transaction id offset

};

} // namespace perfdhcp
} // namespace isc

#endif // __PERF_PKT4_H