ovsdb-error: New function ovsdb_error_to_json_free().

This simplifies little bits of code here and there.

Signed-off-by: Ben Pfaff <blp@ovn.org>
Tested-by: Yifeng Sun <pkusunyifeng@gmail.com>
Reviewed-by: Yifeng Sun <pkusunyifeng@gmail.com>

2 files changed, 18 insertions, 0 deletions

diff --git a/lib/ovsdb-error.c b/lib/ovsdb-error.c
index 9b1af68c6..a75ad36b7 100644
--- a/lib/ovsdb-error.c
+++ b/lib/ovsdb-error.c
@@ -203,6 +203,8 @@ ovsdb_error_clone(const struct ovsdb_error *old)
     }
 }
 
+/* Returns 'error' converted to the <error> JSON object format described in RFC
+ * 7047.  The caller must free the returned json (with json_destroy()). */
 struct json *
 ovsdb_error_to_json(const struct ovsdb_error *error)
 {
@@ -211,6 +213,8 @@ ovsdb_error_to_json(const struct ovsdb_error *error)
     if (error->details) {
         json_object_put_string(json, "details", error->details);
     }
+
+    /* These are RFC 7047-compliant extensions. */
     if (error->syntax) {
         json_object_put_string(json, "syntax", error->syntax);
     }
@@ -218,6 +222,19 @@ ovsdb_error_to_json(const struct ovsdb_error *error)
         json_object_put_string(json, "io-error",
                                ovs_retval_to_string(error->errno_));
     }
+
+    return json;
+}
+
+/* Returns 'error' converted to the <error> JSON object format described in RFC
+ * 7047.  The caller must free the returned json (with json_destroy()).
+ *
+ * Also, frees 'error'. */
+struct json *
+ovsdb_error_to_json_free(struct ovsdb_error *error)
+{
+    struct json *json = ovsdb_error_to_json(error);
+    ovsdb_error_destroy(error);
     return json;
 }
 
diff --git a/lib/ovsdb-error.h b/lib/ovsdb-error.h
index ff9b889a8..77a60e074 100644
--- a/lib/ovsdb-error.h
+++ b/lib/ovsdb-error.h
@@ -66,6 +66,7 @@ struct ovsdb_error *ovsdb_error_clone(const struct ovsdb_error *)
 char *ovsdb_error_to_string(const struct ovsdb_error *);
 char *ovsdb_error_to_string_free(struct ovsdb_error *);
 struct json *ovsdb_error_to_json(const struct ovsdb_error *);
+struct json *ovsdb_error_to_json_free(struct ovsdb_error *);
 
 const char *ovsdb_error_get_tag(const struct ovsdb_error *);