Remoting NG Release Notes

Release 2024.2

Summary of Changes

Significant improvements to the WSDL/XML Schema code generator (XSDGen), which now allow it to successfully process very complex WSDL and XML Schema documents, including the ONVIF specifications.
C++ classes generated for XML elements by XSDGen now provide additional setter functions taking an rvalue reference for move assignment.
Code generated by XSDGen can now use std::shared_ptr instead of Poco::SharedPtr and std::optional instead of Poco::Optional.
The SOAP transport now supports WS-Security authentication with the Username Token Profile. On the client side (Poco::RemotingNG::SOAP::Transport), WS-Security is supported by setting the respective authentication mode (AUTH_WSSE_TEXT or AUTH_WSSE_DIGEST).
HTTP-based transports (Poco::RemotingNG::HTTP::Transport, Poco::RemotingNG::JSONRPC::Transport, Poco::RemotingNG::REST::Transport, Poco::RemotingNG::SOAP::Transport) now allow setting custom HTTP headers for requests.
The SOAP transport library provides a new Poco::RemotingNG::SOAP::SOAPFaultException class, which provides access to all XML elements from the SOAP Fault element. This exception is now thrown instead of a generic Poco::RemotingNG::RemoteException if the server returns a SOAP Fault. The SOAPFaultException class is a subclass of RemoteException to maintain backwards compatibility.
The REST transport library provides a new Poco::RemotingNG::REST::RESTServerException class, which provides access to the JSON content that is sent as part of an error response (HTTP status code >= 400) from the server. This exception is now thrown instead of a generic Poco::RemotingNG::RemoteException if the sends a response with an error status code. The RESTServerException class is a subclass of RemoteException to maintain backwards compatibility.

Incompatible Changes and Possible Transition Issues

The REST and SOAP transports now throw a subclass of Poco::RemotingNG::RemoteException, in case of an error reported by the server, so the exception message will be slightly different.

Release 2024.1

Summary of Changes

Support for serialization of std::optional in C++17.
The serialization and deserialization code generated by RemoteGen will now serialize struct and class members in order of their declaration, and no longer in lexical order as previously. This is a breaking change and requires action. See the note below for more information, including how to configure previous behavior.
The length attribute is now supported for sequences and strings.
New xsdType attribute that is used by the SOAP transport (and WSDL/XML Schema code generator) to convey the original XML Schema type to the serializer/deserializer. Currently used for serialization of data, time and dateTime types, which are all mapped to Poco::DateTime.
Fixed an issue in the TCP transport that prevented using the TCP transport with Unix domain sockets.
RemoteGen now generates more modern-style C++ code.
Various minor fixes and improvements.

Incompatible Changes and Possible Transition Issues

The serialization and deserialization code generated by RemoteGen will now serialize struct and class members in order of their declaration, and no longer in lexical order as before.

This unfortunately breaks the binary protocol for the TCP and HTTP transports, so if these transports are used, the Remoting code for all clients and servers must be re-generated and rebuilt to prevent serialization/deserialization problems.

Alternatively, it is possible to restore the old serialization behavior by adding an option to the RemoteGen configuration file:

<options>
  <memberSerializationOrder>lexical</memberSerializationOrder>
</options>

The options element must be added under the RemoteGen element, next to the files and output elements. This ensures full compatibility with existing clients and servers using the TCP or HTTP protocol.