BIND 10 trac2565, updated. b0bc2d360163be4126f6a88b73a3c17a18714736 [2565] Use boost::optional in the newly introduced RRClass factory
BIND 10 source code commits
bind10-changes at lists.isc.org
Wed Dec 19 08:26:18 UTC 2012
The branch, trac2565 has been updated
via b0bc2d360163be4126f6a88b73a3c17a18714736 (commit)
from 1b69710afed58b9f7ebff61229f3f29e487f4026 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit b0bc2d360163be4126f6a88b73a3c17a18714736
Author: Mukund Sivaraman <muks at isc.org>
Date: Wed Dec 19 13:55:17 2012 +0530
[2565] Use boost::optional in the newly introduced RRClass factory
-----------------------------------------------------------------------
Summary of changes:
src/lib/dns/master_loader.cc | 5 ++-
src/lib/dns/rrclass-placeholder.h | 65 ++++++++++++++++++++++++++-------
src/lib/dns/rrclass.cc | 12 ++++--
src/lib/dns/tests/rrclass_unittest.cc | 15 +++-----
4 files changed, 68 insertions(+), 29 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/lib/dns/master_loader.cc b/src/lib/dns/master_loader.cc
index 30b56ed..02b513e 100644
--- a/src/lib/dns/master_loader.cc
+++ b/src/lib/dns/master_loader.cc
@@ -210,8 +210,9 @@ private:
// after the RR class below.
}
- RRClass rrclass(zone_class_);
- if (rrclass.fromText(rrparam_token.getString())) {
+ MaybeRRClass rrclass =
+ RRClass::createFromText(rrparam_token.getString());
+ if (rrclass) {
if (rrclass != zone_class_) {
// It doesn't really matter much what type of exception
// we throw, we catch it just below.
diff --git a/src/lib/dns/rrclass-placeholder.h b/src/lib/dns/rrclass-placeholder.h
index 5ebc2d5..4573738 100644
--- a/src/lib/dns/rrclass-placeholder.h
+++ b/src/lib/dns/rrclass-placeholder.h
@@ -22,6 +22,8 @@
#include <exceptions/exceptions.h>
+#include <boost/optional.hpp>
+
namespace isc {
namespace util {
class InputBuffer;
@@ -33,6 +35,16 @@ namespace dns {
// forward declarations
class AbstractMessageRenderer;
+class RRClass; // forward declaration to define MaybeRRClass.
+
+/// \brief A shortcut for a compound type to represent RRClass-or-not.
+///
+/// A value of this type can be interpreted in a boolean context, whose
+/// value is \c true if and only if it contains a valid RRClass object.
+/// And, if it contains a valid RRClass object, its value is accessible
+/// using \c operator*, just like a bare pointer to \c RRClass.
+typedef boost::optional<RRClass> MaybeRRClass;
+
///
/// \brief A standard DNS module exception that is thrown if an RRClass object
/// is being constructed from an unrecognized string.
@@ -136,6 +148,45 @@ public:
///
/// \param buffer A buffer storing the wire format data.
explicit RRClass(isc::util::InputBuffer& buffer);
+
+ /// A separate factory of RRClass from text.
+ ///
+ /// This static method is similar to the constructor that takes a
+ /// string object, but works as a factory and reports parsing
+ /// failure in the form of the return value. Normally the
+ /// constructor version should suffice, but in some cases the caller
+ /// may have to expect mixture of valid and invalid input, and may
+ /// want to minimize the overhead of possible exception handling.
+ /// This version is provided for such purpose.
+ ///
+ /// For the format of the \c class_str argument, see the
+ /// <code>RRClass(const std::string&)</code> constructor.
+ ///
+ /// If the given text represents a valid RRClass, it returns a
+ /// \c MaybeRRClass object that stores a corresponding \c RRClass
+ /// object, which is accessible via \c operator*(). In this case
+ /// the returned object will be interpreted as \c true in a boolean
+ /// context. If the given text does not represent a valid RRClass,
+ /// it returns a \c MaybeRRClass object which is interpreted as
+ /// \c false in a boolean context.
+ ///
+ /// One main purpose of this function is to minimize the overhead
+ /// when the given text does not represent a valid RR class. For
+ /// this reason this function intentionally omits the capability of
+ /// delivering details reason for the parse failure, such as in the
+ /// \c want() string when exception is thrown from the constructor
+ /// (it will internally require a creation of string object, which
+ /// is relatively expensive). If such detailed information is
+ /// necessary, the constructor version should be used to catch the
+ /// resulting exception.
+ ///
+ /// This function never throws the \c InvalidRRClass exception.
+ ///
+ /// \param class_str A string representation of the \c RRClass.
+ /// \return A MaybeRRClass object either storing an RRClass object
+ /// for the given text or a \c false value.
+ static MaybeRRClass createFromText(const std::string& class_str);
+
///
/// We use the default copy constructor intentionally.
//@}
@@ -181,20 +232,6 @@ public:
/// \param renderer DNS message rendering context that encapsulates the
/// output buffer in which the RRClass is to be stored.
void toWire(isc::util::OutputBuffer& buffer) const;
-
- /// \brief Assign this \c RRClass from string.
- ///
- /// This method assigns this \c RRClass from the string
- /// representation passed in \c class_str. For the format of this
- /// string, see the <code>RRClass(const std::string&)</code>
- /// constructor.
- ///
- /// If the conversion from string passes, true is
- /// returned. Otherwise false is returned.
- ///
- /// \param class_str A string representation of the \c RRClass
- /// \return true if \c class_str was valid, false otherwise.
- bool fromText(const std::string& class_str);
//@}
///
diff --git a/src/lib/dns/rrclass.cc b/src/lib/dns/rrclass.cc
index a608dc8..70907bd 100644
--- a/src/lib/dns/rrclass.cc
+++ b/src/lib/dns/rrclass.cc
@@ -60,10 +60,14 @@ RRClass::toWire(AbstractMessageRenderer& renderer) const {
renderer.writeUint16(classcode_);
}
-bool
-RRClass::fromText(const std::string& class_str) {
- return (RRParamRegistry::getRegistry().textToClassCode(class_str,
- classcode_));
+MaybeRRClass
+RRClass::createFromText(const string& class_str) {
+ uint16_t class_code;
+ if (RRParamRegistry::getRegistry().textToClassCode(class_str,
+ class_code)) {
+ return (MaybeRRClass(class_code));
+ }
+ return (MaybeRRClass());
}
ostream&
diff --git a/src/lib/dns/tests/rrclass_unittest.cc b/src/lib/dns/tests/rrclass_unittest.cc
index 697a51c..c8c2a69 100644
--- a/src/lib/dns/tests/rrclass_unittest.cc
+++ b/src/lib/dns/tests/rrclass_unittest.cc
@@ -96,15 +96,12 @@ TEST_F(RRClassTest, toText) {
EXPECT_EQ("CLASS65000", RRClass(65000).toText());
}
-TEST_F(RRClassTest, fromText) {
- RRClass frc(1);
- EXPECT_EQ("IN", frc.toText());
- EXPECT_TRUE(frc.fromText("CH"));
- EXPECT_EQ("CH", frc.toText());
- EXPECT_FALSE(frc.fromText("ZZ"));
- EXPECT_EQ("CH", frc.toText());
- EXPECT_TRUE(frc.fromText("IN"));
- EXPECT_EQ("IN", frc.toText());
+TEST_F(RRClassTest, createFromText) {
+ MaybeRRClass rrclass("IN");
+ EXPECT_TRUE(rrclass);
+ EXPECT_EQ("IN", rrclass->toText());
+ EXPECT_TRUE(RRClass::createFromText("CH"));
+ EXPECT_FALSE(RRClass::createFromText("ZZ"));
}
TEST_F(RRClassTest, toWireBuffer) {
More information about the bind10-changes
mailing list