message_exception.h 3.36 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// 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 __MESSAGE_EXCEPTION_H
#define __MESSAGE_EXCEPTION_H

18 19 20
#include <exceptions/exceptions.h>
#include <log/message_types.h>

21 22 23 24
#include <stdexcept>
#include <string>
#include <vector>

Stephen Morris's avatar
Stephen Morris committed
25
#include <boost/lexical_cast.hpp>
26 27 28 29 30 31 32 33 34 35

namespace isc {
namespace log {

/// \brief Message Exception
///
/// Used in the message reader, this simple exception class allows a message
/// code and its arguments to be encapsulated in an exception and thrown
/// up the stack.

36
class MessageException : public isc::Exception {
37 38 39 40
public:

    /// \brief Constructor
    ///
Stephen Morris's avatar
Stephen Morris committed
41 42
    /// \param id Message identification.
    /// \param lineno Line number on which error occurred (if > 0).
43 44 45
    MessageException(const char* file, size_t line,
                     MessageID id, int lineno = 0)
        : isc::Exception(file, line, ""), id_(id)
Stephen Morris's avatar
Stephen Morris committed
46 47 48 49 50
    {
        if (lineno > 0) {
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
    }
51 52 53

    /// \brief Constructor
    ///
Stephen Morris's avatar
Stephen Morris committed
54 55 56
    /// \param id Message identification.
    /// \param arg1 First message argument.
    /// \param lineno Line number on which error occurred (if > 0).
57 58 59
    MessageException(const char* file, size_t line,
                     MessageID id, const std::string& arg1, int lineno = 0)
        : isc::Exception(file, line, ""), id_(id)
60
    {
Stephen Morris's avatar
Stephen Morris committed
61 62 63
        if (lineno > 0) {
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
64 65 66 67 68
        args_.push_back(arg1);
    }

    /// \brief Constructor
    ///
Stephen Morris's avatar
Stephen Morris committed
69 70 71 72
    /// \param id Message identification.
    /// \param arg1 First message argument.
    /// \param arg2 Second message argument.
    /// \param lineno Line number on which error occurred (if > 0).
73 74 75 76
    MessageException(const char* file, size_t line,
                     MessageID id, const std::string& arg1,
                     const std::string& arg2, int lineno = 0)
        : isc::Exception(file, line, ""), id_(id)
77
    {
Stephen Morris's avatar
Stephen Morris committed
78 79 80
        if (lineno > 0) {
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
81 82 83 84 85
        args_.push_back(arg1);
        args_.push_back(arg2);
    }

    /// \brief Destructor
Stephen Morris's avatar
Stephen Morris committed
86
    ~MessageException() throw() {}
87 88 89 90 91 92 93 94 95 96 97 98

    /// \brief Return Message ID
    ///
    /// \return Message identification
    MessageID id() const {
        return id_;
    }

    /// \brief Return Arguments
    ///
    /// \return Exception Arguments
    std::vector<std::string> arguments() const {
99
        return (args_);
100 101 102 103 104 105 106 107 108 109 110
    }

private:
    MessageID                   id_;        // Exception ID
    std::vector<std::string>    args_;      // Exception arguments
};

} // namespace log
} // namespace isc

#endif // __MESSAGE_EXCEPTION_H