Changeset 427:0a7e413412e9 in finroc_core

Timestamp:

14.05.2017 13:20:19 (7 years ago)

Author:

Max Reichardt <mreichardt@…>

Branch:

17.03

Phase:

public

Message:

Unifies and optimizes serialization of tConnectOptions and tUriConnectOptions (for uniform handling on Java side). Makes sure that auto-set flags erroneously set by user are ignored.

Location:

port

Files:

• tConnectOptions.cpp (added)
• tConnectOptions.h (modified) (4 diffs)
• tConnector.cpp (modified) (1 diff)
• tUriConnectOptions.h (modified) (1 diff)
• tUriConnector.cpp (modified) (1 diff)

port/tConnectOptions.h

@@ -60 +60 @@
 //----------------------------------------------------------------------
 /*!
- * Flags that can be set for connections/connectors
+ * Flags that can be set for connections/connectors.
+ * First 16 Bits are sent to Finstruct
  */
 enum class tConnectionFlag
@@ -79 +80 @@
   NON_PRIMARY_CONNECTOR, //!< Connector was created and is represented by higher-level connector (that still exists) (-> e.g. not necessary to transfer this connector to finstruct)
 
+  // unused flags for future use
+  UNUSED_8, UNUSED_9, UNUSED_10, UNUSED_11, UNUSED_12, UNUSED_13, UNUSED_14,
+
   // these flags are automatically set
+  CONVERSION,            //!< Connector has type conversion operations attached that must be applied on publishing values
+  NAMED_PARAMETERS,      //!< Indicates whether connector options include named parameters (relevant mainly for uniform serialization of ConnectOptions and UriConnectorOptions (only the latter supports named parameters))
   PUBLISHED,             //!< Only relevant for URI connectors: Has been published
   DISCONNECTED,          //!< Connector has been removed
-  CONVERSION             //!< Connector has type conversion operations attached that must be applied on publishing values
 };
 
@@ -127 +132 @@
   {}
 
+  /**
+   * Serialize URI connect options
+   *
+   * \param stream Stream to write to
+   * \param auto_set_flags Whether to auto-adjust flags
+   */
+  void Serialize(rrlib::serialization::tOutputStream& stream, bool auto_set_flags) const;
+
+  /**
+   * \param conversion_operations New conversion operations
+   */
   void Set(const rrlib::rtti::conversion::tConversionOperationSequence& conversion_operations)
   {
     this->conversion_operations = conversion_operations;
   }
+  /**
+   * \param conversion_operations New flags
+   */
   void Set(const tConnectionFlags& flags)
   {
     this->flags = flags;
   }
+
+  /*!
+   * Unsets all flags that are automatically set by Finroc core.
+   * (Used for protection against misuse/undefined behavior)
+   *
+   * \param flags Flags to clear from auto-flags
+   * \return Flags with all auto-flags unset
+   */
+  static tConnectionFlags UnsetAutoFlags(const tConnectionFlags& flags);
 };
 
@@ -158 +186 @@
 }
 
+
 inline rrlib::serialization::tOutputStream& operator << (rrlib::serialization::tOutputStream& stream, const tConnectOptions& options)
 {
-  stream << options.conversion_operations << options.flags.Raw();
+  options.Serialize(stream, true);
   return stream;
 }
-
-inline rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream& stream, tConnectOptions& options)
-{
-  stream >> options.conversion_operations;
-  options.flags = tConnectionFlags(stream.ReadInt());
-  return stream;
-}
-
+rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream& stream, tConnectOptions& options);
 
 //----------------------------------------------------------------------

port/tConnector.cpp

@@ -117 +117 @@
   source_port(source_port),
   destination_port(destination_port),
-  flags(connect_options.flags | (&conversion_sequence_storage != &rrlib::rtti::conversion::tConversionOperationSequence::cNONE ? tFlags(tFlag::CONVERSION) : tFlags()))
+  flags(tConnectOptions::UnsetAutoFlags(connect_options.flags) | (&conversion_sequence_storage != &rrlib::rtti::conversion::tConversionOperationSequence::cNONE ? tFlags(tFlag::CONVERSION) : tFlags()))
 {
   if (flags.Get(tFlag::CONVERSION))

port/tUriConnectOptions.h

@@ -75 +75 @@
   /*! Additional parameters as key/value pairs */
   std::map<std::string, std::string> parameters;
+
 };
 
-inline rrlib::serialization::tOutputStream& operator << (rrlib::serialization::tOutputStream& stream, const tUriConnectOptions& options)
-{
-  stream << static_cast<const tConnectOptions&>(options);
-  stream << options.parameters;
-  return stream;
-}
-
-inline rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream& stream, tUriConnectOptions& options)
-{
-  stream >> static_cast<tConnectOptions&>(options);
-  stream >> options.parameters;
-  return stream;
-}
+// implemented in tConnectOptions.cpp (for locality of change - serialization of both classes is compatible)
+rrlib::serialization::tOutputStream& operator << (rrlib::serialization::tOutputStream& stream, const tUriConnectOptions& options);
+rrlib::serialization::tInputStream& operator >> (rrlib::serialization::tInputStream& stream, tUriConnectOptions& options);
 
 //----------------------------------------------------------------------

port/tUriConnector.cpp

@@ -84 +84 @@
 
 tUriConnector::tUriConnector(tOwner& owner, const tURI& uri, const tConnectOptions& connect_options, const tSchemeHandler& scheme_handler) :
-  flags(connect_options.flags),
+  flags(tConnectOptions::UnsetAutoFlags(connect_options.flags) | (connect_options.conversion_operations.Size() ? tFlags(tFlag::CONVERSION) : tFlags())),
   owner(owner),
   conversion_operations(connect_options.conversion_operations),