message_exception.h 2.45 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 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
// 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.

// $Id$

#ifndef __MESSAGE_EXCEPTION_H
#define __MESSAGE_EXCEPTION_H

#include <stdexcept>
#include <string>
#include <vector>

#include <log/message_types.h>

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.

class MessageException : public std::exception {
public:

    /// \brief Constructor
    ///
    /// \param id Message identification
    MessageException(MessageID id) : id_(id)
    {}

    /// \brief Constructor
    ///
    /// \param id Message identification
    /// \param arg1 First message argument
    MessageException(MessageID id, const std::string& arg1) : id_(id)
    {
        args_.push_back(arg1);
    }

    /// \brief Constructor
    ///
    /// \param id Message identification
    /// \param arg1 First message argument
    /// \param arg2 Second message argument
    MessageException(MessageID id, const std::string& arg1,
        const std::string& arg2) : id_(id)
    {
        args_.push_back(arg1);
        args_.push_back(arg2);
    }

    /// \brief Destructor
    virtual ~MessageException() throw();

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

    /// \brief Return Arguments
    ///
    /// \return Exception Arguments
    std::vector<std::string> arguments() const {
        return args_;
    }

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

} // namespace log
} // namespace isc

#endif // __MESSAGE_EXCEPTION_H