diff --git a/src/lib/dns/cpp/rrclass.h b/src/lib/dns/cpp/rrclass.h index 489fb6f4d6..88c79061a1 100644 --- a/src/lib/dns/cpp/rrclass.h +++ b/src/lib/dns/cpp/rrclass.h @@ -28,7 +28,8 @@ class OutputBuffer; class MessageRenderer; /// -/// \brief TBD +/// \brief A standard DNS module exception that is thrown if an RRClass object +/// is being constructed from an unrecognized string. /// class InvalidRRClass : public Exception { public: @@ -46,6 +47,40 @@ public: isc::dns::Exception(file, line, what) {} }; +/// +/// The \c RRClass class encapsulates DNS resource record classes. +/// +/// This class manages the 16-bit integer class codes in quite a straightforward +/// way. The only non trivial task is to handle textual representations of +/// RR classes, such as "IN", "CH", or "CLASS65534". +/// +/// This class consults a helper \c RRParamRegistry class, which is a registry +/// of RR related parameters and has the singleton object. This registry +/// provides a mapping between RR class codes and their "well-known" textual +/// representations. +/// Parameters of RR classes defined by DNS protocol standards are automatically +/// registered at initialization time and are ensured to be always available for +/// applications unless the application explicitly modifies the registry. +/// +/// For convenience, this class defines constant class objects corresponding to +/// standard RR classes. These are generally referred to as the form of +/// RRClass::{class-text}(). +/// For example, \c RRClass::IN() is an \c RRClass object corresponding to the +/// IN class (class code 1). +/// Note that these constants are used through a "proxy" function. +/// This is because they may be used to initialize another non-local (e.g. +/// global or namespace-scope) static object as follows: +/// +/// \code +/// namespace foo { +/// const RRClass default_class = RRClass::IN(); +/// } \endcode +/// +/// In order to ensure that the constant RRClass object has been initialized +/// by the initialization for \c default_class is performed, we need help from +/// the proxy function. +/// +/// Note to developers: same note as \c RRType applies. class RRClass { public: /// @@ -54,9 +89,35 @@ public: //@{ /// Constructor from an integer type code. /// - explicit RRClass(uint16_t classcode) : classcode_(classcode) {} - /// Constructor from a string. + /// This constructor never throws an exception. /// + /// \param classcode An 16-bit integer code corresponding to the RRClass. + explicit RRClass(uint16_t classcode) : classcode_(classcode) {} + /// + /// A valid string is one of "well known" textual class representations + /// such as "IN" or "CH", or in the standard format for "unknown" + /// classes as defined in RFC3597, i.e., "CLASSnnnn". + /// + /// More precisely, the "well-known" representations are the ones stored + /// in the \c RRParamRegistry registry (see the class description). + /// + /// As for the format of "CLASSnnnn", "nnnn" must represent a valid 16-bit + /// unsigned integer, which may contain leading 0's as long as it consists + /// of at most 5 characters (exclusive). + /// For example, "CLASS1" and "CLASSS001" are valid and represent the same + /// class, but "CLASS65536" and "CLASS000001" are invalid. + /// A "CLASSnnnn" representation is valid even if the corresponding class + /// code is registered in the \c RRParamRegistry object. For example, both + /// "IN" and "CLASS1" are valid and represent the same class. + /// + /// All of these representations are case insensitive; "IN" and "in", and + /// "CLASS1" and "class1" are all valid and represent the same classes, + /// respectively. + /// + /// If the given string is not recognized as a valid representation of + /// an RR class, an exception of class \c InvalidRRClass will be thrown. + /// + /// \param classstr A string representation of the \c RRClass explicit RRClass(const std::string& classstr); /// Constructor from wire-format data. /// @@ -74,22 +135,105 @@ public: //@} /// We use the default copy assignment operator intentionally. /// + + /// + /// \name Converter methods + /// + //@{ + /// \brief Convert the \c RRClass to a string. + /// + /// If a "well known" textual representation for the class code is + /// registered in the RR parameter registry (see the class description), + /// that will be used as the return value of this method. Otherwise, this + /// method creates a new string for an "unknown" class in the format defined + /// in RFC3597, i.e., "CLASSnnnn", and returns it. + /// + /// If resource allocation for the string fails, a corresponding standard + /// exception will be thrown. + /// + /// \return A string representation of the \c RRClass. const std::string toText() const; + /// \brief Render the \c RRClass in the wire format. + /// + /// This method renders the class code in network byte order via + /// \c renderer, which encapsulates output buffer and other rendering + /// contexts. + /// + /// If resource allocation in rendering process fails, a corresponding + /// standard exception will be thrown. + /// + /// \param buffer An output buffer to store the wire data. void toWire(OutputBuffer& buffer) const; + /// \brief Render the \c RRClass in the wire format. + /// + /// This method renders the class code in network byte order into the + /// \c buffer. + /// + /// If resource allocation in rendering process fails, a corresponding + /// standard exception will be thrown. + /// + /// \param renderer DNS message rendering context that encapsulates the + /// output buffer in which the RRClass is to be stored. void toWire(MessageRenderer& renderer) const; + //@} + + /// + /// \name Getter Methods + /// + //@{ + /// \brief Returns the RR class code as a 16-bit unsigned integer. + /// + /// This method never throws an exception. + /// + /// \return An 16-bit integer code corresponding to the RRClass. uint16_t getCode() const { return (classcode_); } + //@} + + /// + /// \name Comparison methods + /// + //@{ + /// \brief Return true iff two RRClasses are equal. + /// + /// Two RRClasses are equal iff their class codes are equal. + /// + /// This method never throws an exception. + /// + /// \param other the \c RRClass object to compare against. + /// \return true if the two RRClasses are equal; otherwise false. bool operator==(const RRClass& other) const { return (classcode_ == other.classcode_); } + /// \brief Return true iff two RRClasses are equal. + /// + /// This method never throws an exception. + /// + /// \param other the \c RRClass object to compare against. + /// \return true if the two RRClasses are not equal; otherwise false. bool operator!=(const RRClass& other) const { return (classcode_ != other.classcode_); } + /// \brief Less-than comparison for RRClass against \c other /// - /// We define this so that RRClasss can be stored in STL containers. + /// We define the less-than relationship based on their class codes; + /// one RRClass is less than the other iff the code of the former is less + /// than that of the other as unsigned integers. + /// The relationship is meaningless in terms of DNS protocol; the only + /// reason we define this method is that RRClass objects can be stored in + /// STL containers without requiring user-defined less-than relationship. + /// We therefore don't define other comparison operators. /// + /// This method never throws an exception. + /// + /// \param other the \c RRClass object to compare against. + /// \return true if \c this RRClass is less than the \c other; otherwise + /// false. bool operator<(const RRClass& other) const { return (classcode_ < other.classcode_); } // (Some) Well-known RRclass constants + // Note: we'll auto-generate these in a near future version. These are + // hard-coded for a proof of concept. static const RRClass& IN(); + static const RRClass& CH(); private: uint16_t classcode_; @@ -97,6 +241,7 @@ private: // We'll probably auto generate this code. But in this preliminary version // we simply hard code some selected classes. +// Describing these will be deferred until that point. inline const RRClass& RRClass::IN() { @@ -105,6 +250,28 @@ RRClass::IN() return (rrclass); } +inline const RRClass& +RRClass::CH() +{ + static RRClass rrclass(3); + + return (rrclass); +} + +/// +/// \brief Insert the \c RRClass as a string into stream. +/// +/// This method convert the \c rrclass into a string and inserts it into the +/// output stream \c os. +/// +/// This function overloads the global operator<< to behave as described in +/// ostream::operator<< but applied to \c RRClass objects. +/// +/// \param os A \c std::ostream object on which the insertion operation is +/// performed. +/// \param rrclass The \c RRClass object output by the operation. +/// \return A reference to the same \c std::ostream object referenced by +/// parameter \c os after the insertion operation. std::ostream& operator<<(std::ostream& os, const RRClass& rrclass); }