iox-#27 Implement stream operator for ClientSendError and ServerSendError

Author: elBoberido

iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.hpp

@@ -38,6 +38,23 @@ enum class ClientSendError
     INVALID_REQUEST,
 };
 
+/// @brief Converts the ClientSendError to a string literal
+/// @param[in] value to convert to a string literal
+/// @return pointer to a string literal
+inline constexpr const char* asStringLiteral(const ClientSendError value) noexcept;
+
+/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @param[in] stream sink to write the message to
+/// @param[in] value to convert to a string literal
+/// @return the reference to `stream` which was provided as input parameter
+inline std::ostream& operator<<(std::ostream& stream, ClientSendError value) noexcept;
+
+/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @param[in] stream sink to write the message to
+/// @param[in] value to convert to a string literal
+/// @return the reference to `stream` which was provided as input parameter
+inline log::LogStream& operator<<(log::LogStream& stream, ClientSendError value) noexcept;
+
 /// @brief The ClientPortUser provides the API for accessing a client port from the user side. The client port
 /// is divided in the three parts ClientPortData, ClientPortRouDi and ClientPortUser. The ClientPortUser
 /// uses the functionality of a ChunkSender and ChunReceiver for sending requests and receiving responses.
@@ -137,4 +154,6 @@ class ClientPortUser : public BasePort
 } // namespace popo
 } // namespace iox
 
+#include "iceoryx_posh/internal/popo/ports/client_port_user.inl"
+
 #endif // IOX_POSH_POPO_PORTS_CLIENT_PORT_USER_HPP

iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.inl

@@ -0,0 +1,56 @@
+// Copyright (c) 2022 by Apex.AI Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef IOX_POSH_POPO_PORTS_CLIENT_PORT_USER_INL
+#define IOX_POSH_POPO_PORTS_CLIENT_PORT_USER_INL
+
+#include "iceoryx_posh/internal/popo/ports/client_port_user.hpp"
+
+namespace iox
+{
+namespace popo
+{
+inline constexpr const char* asStringLiteral(const ClientSendError value) noexcept
+{
+    switch (value)
+    {
+    case ClientSendError::NO_CONNECT_REQUESTED:
+        return "ClientSendError::NO_CONNECT_REQUESTED";
+    case ClientSendError::SERVER_NOT_AVAILABLE:
+        return "ClientSendError::SERVER_NOT_AVAILABLE";
+    case ClientSendError::INVALID_REQUEST:
+        return "ClientSendError::INVALID_REQUEST";
+    }
+
+    return "[Undefined ClientSendError]";
+}
+
+inline std::ostream& operator<<(std::ostream& stream, ClientSendError value) noexcept
+{
+    stream << asStringLiteral(value);
+    return stream;
+}
+
+inline log::LogStream& operator<<(log::LogStream& stream, ClientSendError value) noexcept
+{
+    stream << asStringLiteral(value);
+    return stream;
+}
+
+} // namespace popo
+} // namespace iox
+
+#endif // IOX_POSH_POPO_PORTS_CLIENT_PORT_USER_INL

iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.hpp

@@ -74,6 +74,23 @@ enum class ServerSendError
     INVALID_RESPONSE,
 };
 
+/// @brief Converts the ServerSendError to a string literal
+/// @param[in] value to convert to a string literal
+/// @return pointer to a string literal
+inline constexpr const char* asStringLiteral(const ServerSendError value) noexcept;
+
+/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @param[in] stream sink to write the message to
+/// @param[in] value to convert to a string literal
+/// @return the reference to `stream` which was provided as input parameter
+inline std::ostream& operator<<(std::ostream& stream, ServerSendError value) noexcept;
+
+/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @param[in] stream sink to write the message to
+/// @param[in] value to convert to a string literal
+/// @return the reference to `stream` which was provided as input parameter
+inline log::LogStream& operator<<(log::LogStream& stream, ServerSendError value) noexcept;
+
 /// @brief The ServerPortUser provides the API for accessing a server port from the user side. The server port
 /// is divided in the three parts ServerPortData, ServerPortRouDi and ServerPortUser. The ServerPortUser
 /// uses the functionality of a ChunkSender and ChunReceiver for receiving requests and sending responses.

iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.inl

@@ -17,6 +17,8 @@
 #ifndef IOX_POSH_POPO_PORTS_SERVER_PORT_USER_INL
 #define IOX_POSH_POPO_PORTS_SERVER_PORT_USER_INL
 
+#include "iceoryx_posh/internal/popo/ports/server_port_user.hpp"
+
 namespace iox
 {
 namespace cxx
@@ -67,6 +69,33 @@ inline log::LogStream& operator<<(log::LogStream& stream, ServerRequestResult va
     return stream;
 }
 
+inline constexpr const char* asStringLiteral(const ServerSendError value) noexcept
+{
+    switch (value)
+    {
+    case ServerSendError::NOT_OFFERED:
+        return "ServerSendError::NOT_OFFERED";
+    case ServerSendError::CLIENT_NOT_AVAILABLE:
+        return "ServerSendError::CLIENT_NOT_AVAILABLE";
+    case ServerSendError::INVALID_RESPONSE:
+        return "ServerSendError::INVALID_RESPONSE";
+    }
+
+    return "[Undefined ServerSendError]";
+}
+
+inline std::ostream& operator<<(std::ostream& stream, ServerSendError value) noexcept
+{
+    stream << asStringLiteral(value);
+    return stream;
+}
+
+inline log::LogStream& operator<<(log::LogStream& stream, ServerSendError value) noexcept
+{
+    stream << asStringLiteral(value);
+    return stream;
+}
+
 } // namespace popo
 } // namespace iox