message_exception.h 3.94 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// 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.

15 16
#ifndef MESSAGE_EXCEPTION_H
#define MESSAGE_EXCEPTION_H
17

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
    ///
41 42 43
    /// \param file Filename where the exception occurred.
    /// \param line Line where exception occurred.
    /// \param what Text description of the problem.
Stephen Morris's avatar
Stephen Morris committed
44 45
    /// \param id Message identification.
    /// \param lineno Line number on which error occurred (if > 0).
46 47 48
    MessageException(const char* file, size_t line, const char* what,
                     MessageID id, int lineno)
        : isc::Exception(file, line, what), id_(id), lineno_(lineno)
Stephen Morris's avatar
Stephen Morris committed
49
    {
50
        if (lineno_ > 0) {
Stephen Morris's avatar
Stephen Morris committed
51 52 53
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
    }
54 55 56

    /// \brief Constructor
    ///
57 58 59
    /// \param file Filename where the exception occurred.
    /// \param line Line where exception occurred.
    /// \param what Text description of the problem.
Stephen Morris's avatar
Stephen Morris committed
60 61 62
    /// \param id Message identification.
    /// \param arg1 First message argument.
    /// \param lineno Line number on which error occurred (if > 0).
63 64
    MessageException(const char* file, size_t line, const char* what,
                     MessageID id, const std::string& arg1, int lineno)
65
        : isc::Exception(file, line, what), id_(id), lineno_(lineno)
66
    {
Stephen Morris's avatar
Stephen Morris committed
67 68 69
        if (lineno > 0) {
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
70 71 72 73 74
        args_.push_back(arg1);
    }

    /// \brief Constructor
    ///
75 76 77
    /// \param file Filename where the exception occurred.
    /// \param line Line where exception occurred.
    /// \param what Text description of the problem.
Stephen Morris's avatar
Stephen Morris committed
78 79 80 81
    /// \param id Message identification.
    /// \param arg1 First message argument.
    /// \param arg2 Second message argument.
    /// \param lineno Line number on which error occurred (if > 0).
82
    MessageException(const char* file, size_t line, const char *what,
83
                     MessageID id, const std::string& arg1,
84
                     const std::string& arg2, int lineno)
85
        : isc::Exception(file, line, what), id_(id), lineno_(lineno)
86
    {
Stephen Morris's avatar
Stephen Morris committed
87 88 89
        if (lineno > 0) {
            args_.push_back(boost::lexical_cast<std::string>(lineno));
        }
90 91 92 93 94
        args_.push_back(arg1);
        args_.push_back(arg2);
    }

    /// \brief Destructor
Stephen Morris's avatar
Stephen Morris committed
95
    ~MessageException() throw() {}
96 97 98 99 100 101 102 103 104 105 106 107

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

    /// \brief Return Arguments
    ///
    /// \return Exception Arguments
    std::vector<std::string> arguments() const {
108
        return (args_);
109 110 111 112 113
    }

private:
    MessageID                   id_;        // Exception ID
    std::vector<std::string>    args_;      // Exception arguments
114
    int lineno_;
115 116 117 118 119
};

} // namespace log
} // namespace isc

120
#endif // MESSAGE_EXCEPTION_H