Bläddra i källkod

Rename ProtocolFamily struct to match convention

Patrick-Christopher Mattulat 2 år sedan
förälder
incheckning
38dd225d34

+ 2 - 2
include/ls_std/ls_std_network.hpp

@@ -3,15 +3,15 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-11-16
- * Changed:         2022-11-18
+ * Changed:         2022-12-09
  *
  * */
 
 #ifndef LS_STD_LS_STD_NETWORK_HPP
 #define LS_STD_LS_STD_NETWORK_HPP
 
+#include <ls_std/network/core/ConvertedProtocolFamily.hpp>
 #include <ls_std/network/core/Protocol.hpp>
-#include <ls_std/network/core/ProtocolFamily.hpp>
 #include <ls_std/network/core/ProtocolFamilyMapper.hpp>
 #include <ls_std/network/core/ProtocolFamilyType.hpp>
 #include <ls_std/network/core/ProtocolMapper.hpp>

+ 4 - 4
include/ls_std/network/core/ProtocolFamily.hpp → include/ls_std/network/core/ConvertedProtocolFamily.hpp

@@ -3,16 +3,16 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-11-16
- * Changed:         2022-11-16
+ * Changed:         2022-12-09
  *
  * */
 
-#ifndef LS_STD_PROTOCOL_FAMILY_HPP
-#define LS_STD_PROTOCOL_FAMILY_HPP
+#ifndef LS_STD_CONVERTED_PROTOCOL_FAMILY_HPP
+#define LS_STD_CONVERTED_PROTOCOL_FAMILY_HPP
 
 namespace ls::std::network
 {
-  struct ProtocolFamily
+  struct ConvertedProtocolFamily
   {
     int unixDomain{};
   };

+ 4 - 4
include/ls_std/network/core/ProtocolFamilyMapper.hpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-11-16
- * Changed:         2022-11-16
+ * Changed:         2022-12-09
  *
  * */
 
@@ -11,7 +11,7 @@
 #define LS_STD_PROTOCOL_FAMILY_MAPPER_HPP
 
 #include <ls_std/core/Class.hpp>
-#include <ls_std/network/core/ProtocolFamily.hpp>
+#include <ls_std/network/core/ConvertedProtocolFamily.hpp>
 #include <ls_std/network/core/ProtocolFamilyType.hpp>
 #include <ls_std/os/dynamic_goal.hpp>
 
@@ -24,12 +24,12 @@ namespace ls::std::network
       ProtocolFamilyMapper();
       ~ProtocolFamilyMapper() override = default;
 
-      [[nodiscard]] static ls::std::network::ProtocolFamily from(const ls::std::network::ProtocolFamilyType& _protocolFamilyType);
+      [[nodiscard]] static ls::std::network::ConvertedProtocolFamily from(const ls::std::network::ProtocolFamilyType& _protocolFamilyType);
 
     private:
 
       #if defined(unix) || defined(__APPLE__)
-      [[nodiscard]] static ls::std::network::ProtocolFamily _toUnixProtocolFamily(const ls::std::network::ProtocolFamilyType& _protocolFamilyType);
+      [[nodiscard]] static ls::std::network::ConvertedProtocolFamily _toUnixProtocolFamily(const ls::std::network::ProtocolFamilyType& _protocolFamilyType);
       #endif
   };
 }

+ 6 - 6
source/ls_std/network/core/ProtocolFamilyMapper.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2022-11-16
- * Changed:         2022-11-16
+ * Changed:         2022-12-09
  *
  * */
 
@@ -16,7 +16,7 @@
 ls::std::network::ProtocolFamilyMapper::ProtocolFamilyMapper() : ls::std::core::Class("ProtocolFamilyMapper")
 {}
 
-ls::std::network::ProtocolFamily ls::std::network::ProtocolFamilyMapper::from(const ls::std::network::ProtocolFamilyType &_protocolFamilyType)
+ls::std::network::ConvertedProtocolFamily ls::std::network::ProtocolFamilyMapper::from(const ls::std::network::ProtocolFamilyType &_protocolFamilyType)
 {
   #if defined(unix) || defined(__APPLE__)
   return ls::std::network::ProtocolFamilyMapper::_toUnixProtocolFamily(_protocolFamilyType);
@@ -24,15 +24,15 @@ ls::std::network::ProtocolFamily ls::std::network::ProtocolFamilyMapper::from(co
 }
 
 #if defined(unix) || defined(__APPLE__)
-ls::std::network::ProtocolFamily ls::std::network::ProtocolFamilyMapper::_toUnixProtocolFamily(const ls::std::network::ProtocolFamilyType &_protocolFamilyType)
+ls::std::network::ConvertedProtocolFamily ls::std::network::ProtocolFamilyMapper::_toUnixProtocolFamily(const ls::std::network::ProtocolFamilyType &_protocolFamilyType)
 {
-  ls::std::network::ProtocolFamily protocolFamily{};
+  ls::std::network::ConvertedProtocolFamily convertedProtocolFamily{};
 
   switch(_protocolFamilyType)
   {
     case ls::std::network::ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_IPV4:
     {
-      protocolFamily.unixDomain = AF_INET;
+      convertedProtocolFamily.unixDomain = AF_INET;
     } break;
     case ls::std::network::ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_NOT_INITIALIZED:
     {
@@ -40,6 +40,6 @@ ls::std::network::ProtocolFamily ls::std::network::ProtocolFamilyMapper::_toUnix
     }
   }
 
-  return protocolFamily;
+  return convertedProtocolFamily;
 }
 #endif

+ 2 - 2
source/ls_std/network/socket/Socket.cpp

@@ -64,9 +64,9 @@ bool ls::std::network::Socket::_init(const ls::std::network::SocketParameter &_p
 #if defined(unix) || defined(__APPLE__)
 bool ls::std::network::Socket::_initUnix(const ls::std::network::SocketParameter &_parameter)
 {
-  ls::std::network::ProtocolFamily protocolFamily = ls::std::network::ProtocolFamilyMapper::from(_parameter.protocolFamilyType);
+  ls::std::network::ConvertedProtocolFamily convertedProtocolFamily = ls::std::network::ProtocolFamilyMapper::from(_parameter.protocolFamilyType);
   ls::std::network::Protocol protocol = ls::std::network::ProtocolMapper::from(_parameter.socketAddress.protocolType);
 
-  return ::socket(protocolFamily.unixDomain, protocol.unixProtocol, 0);
+  return ::socket(convertedProtocolFamily.unixDomain, protocol.unixProtocol, 0);
 }
 #endif

+ 3 - 3
source/ls_std/network/socket/SocketAddressMapper.cpp

@@ -8,7 +8,7 @@
  * */
 
 #include <ls_std/network/socket/SocketAddressMapper.hpp>
-#include <ls_std/network/core/ProtocolFamily.hpp>
+#include <ls_std/network/core/ConvertedProtocolFamily.hpp>
 #include <ls_std/network/core/ProtocolFamilyMapper.hpp>
 #if defined(unix) || defined(__APPLE__)
 #include <netinet/in.h>
@@ -35,8 +35,8 @@ ls::std::network::ConvertedSocketAddress ls::std::network::SocketAddressMapper::
   ::sockaddr_in socketAddressUnix{};
   socketAddressUnix.sin_port = ::htons(_parameter.socketAddress.port);
 
-  ls::std::network::ProtocolFamily protocolFamily = ls::std::network::ProtocolFamilyMapper::from(_parameter.protocolFamilyType);
-  socketAddressUnix.sin_family = protocolFamily.unixDomain;
+  ls::std::network::ConvertedProtocolFamily convertedProtocolFamily = ls::std::network::ProtocolFamilyMapper::from(_parameter.protocolFamilyType);
+  socketAddressUnix.sin_family = convertedProtocolFamily.unixDomain;
   ::inet_aton(_parameter.socketAddress.ipAddress.c_str(), &socketAddressUnix.sin_addr);
 
   return socketAddressUnix;

+ 4 - 4
test/cases/network/core/ProtocolFamilyMapperTest.cpp

@@ -3,7 +3,7 @@
  * Company:         Lynar Studios
  * E-Mail:          webmaster@lynarstudios.com
  * Created:         2020-11-16
- * Changed:         2022-11-17
+ * Changed:         2022-12-09
  *
  * */
 
@@ -40,10 +40,10 @@ namespace
 
   TEST_F(ProtocolFamilyMapperTest, from)
   {
-    ProtocolFamily protocolFamily = ProtocolFamilyMapper::from(ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_IPV4);
+    ConvertedProtocolFamily convertedProtocolFamily = ProtocolFamilyMapper::from(ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_IPV4);
 
     #if defined(unix) || defined(__APPLE__)
-    ASSERT_EQ(AF_INET, protocolFamily.unixDomain);
+    ASSERT_EQ(AF_INET, convertedProtocolFamily.unixDomain);
     #endif
   }
 
@@ -52,7 +52,7 @@ namespace
     EXPECT_THROW({
                    try
                    {
-                     ProtocolFamily protocolFamily = ProtocolFamilyMapper::from(ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_NOT_INITIALIZED);
+                     ConvertedProtocolFamily convertedProtocolFamily = ProtocolFamilyMapper::from(ProtocolFamilyType::PROTOCOL_FAMILY_TYPE_NOT_INITIALIZED);
                    }
                    catch (const IllegalArgumentException &_exception)
                    {