Feature/refactoring

CONTRIBUTING.md

@@ -145,6 +145,11 @@ Functions like `malloc`, `calloc`, and `free` are forbidden in C++ code.
 
 Speaking of class layout, [*the rule of zero*](https://en.cppreference.com/w/cpp/language/rule_of_three.html) is preferred 
 
+### Code documenting
+
+Comments in code are preferred, but not always necessary. There are some basic rules of proper code documentation, 
+which can be found [here](https://developer.lsst.io/cpp/api-docs.html).
+
 ---
 
 If you find code that doesn’t follow these guidelines, [open an issue](https://github.com/kbrddestroyer/AxonEngine/issues/new) with the `refactoring` label.

cmake/build-utils.cmake

@@ -10,7 +10,7 @@ function(add_all_subdirs)
     endforeach()
 endfunction()
 
-function(list_all_tests name_pattern)
+function(list_all_tests_separate name_pattern)
     file (GLOB_RECURSE TEST_SOURCES ${name_pattern})
 
     foreach (TEST_SRC ${TEST_SOURCES})
@@ -31,3 +31,20 @@ function(list_all_tests name_pattern)
         message ("Loaded test sequence: ${FILENAME}")
     endforeach ()
 endfunction()
+
+function(list_all_tests name_pattern)
+    file (GLOB_RECURSE TEST_SOURCES ${name_pattern})
+    get_filename_component(FOLDER ${CMAKE_CURRENT_SOURCE_DIR} NAME_WE)
+    string (TOUPPER ${FOLDER} FOLDER)
+
+    add_executable(TEST_${FOLDER}_TARGET ${TEST_SOURCES} "entry.cpp")
+    add_test(NAME TEST_${FOLDER} COMMAND $<TARGET_FILE:TEST_${FOLDER}_TARGET>)
+    target_link_libraries(TEST_${FOLDER}_TARGET PRIVATE ${ARGN})
+
+    add_custom_command(TARGET TEST_${FOLDER}_TARGET POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy -t $<TARGET_FILE_DIR:TEST_${FOLDER}_TARGET> $<TARGET_RUNTIME_DLLS:TEST_${FOLDER}_TARGET>
+            COMMAND_EXPAND_LISTS
+    )
+
+    message ("Loaded test folder: TEST_${FOLDER}")
+endfunction()

examples/README.md

@@ -0,0 +1,2 @@
+# Examples
+

examples/basics/basic-synapse/client.cpp

@@ -1,12 +1,12 @@
 /*
-* This example shows basic connection, using Axon internal tools
-* Synapse provides connection between two points
+* This example shows basic client connection, using Axon internal tools.
+* Synapse provides connection between two points, this one is created in client mode.
 * 
-* This file defined basic client logic, with AxonMessage forming and sending with Synapse tool
+* This file defined basic client logic. It creates Message package and sends it to server. Also, it is capable of
+* server messages handling, displaying response packages.
 */
 
-#include <networking/AxonNetwork.hpp>
-#include <cstring>
+#include <networking/AxonLibrary.hpp>
 #include <iostream>
 
 #include <chrono>
@@ -34,12 +34,12 @@ void onMessageReceived(const Networking::SynapseMessageReceivedEvent& event)
 
 int main()
 {
-	Networking::ConnectionInfo connection = { "localhost", 10423 };
-
-	Networking::AsyncSynapse<Networking::ConnectionMode::UDP, Networking::SynapseMode::CLIENT> clientConnection(connection);
+	Networking::AsyncSynapse<
+            Networking::BerkeleyAxonNetworkController<Networking::TCP, Networking::SynapseMode::CLIENT>
+            > clientConnection("localhost", 10423);
     clientConnection.getEventManager().subscribe<Networking::SynapseMessageReceivedEvent>(onMessageReceived);
-
     clientConnection.start();
+
     time_t startTimestamp = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
 
     Networking::AxonMessage msg(nullptr, 0);
@@ -50,12 +50,15 @@ int main()
     {
         std::this_thread::sleep_for(std::chrono::seconds(1));
 
-        std::stringstream sstream;
+        std::stringstream stream;
 
-        sstream <<
+        stream <<
             "Sending message on " <<
             std::chrono::system_clock::to_time_t(std::chrono::system_clock::now()) - startTimestamp;
-        Networking::AxonMessage message_(const_cast<char*>(sstream.str().c_str()), sstream.str().length() + 1, 0, Networking::TAG_FLAGS::VALIDATE);
+
+        std::cout << "Sending: " << stream.str() << std::endl;
+
+        Networking::AxonMessage message_(const_cast<char*>(stream.str().c_str()), stream.str().length() + 2, 0, Networking::TAG_FLAGS::VALIDATE);
 
         clientConnection.send(message_);
     }

examples/basics/basic-synapse/server.cpp

@@ -1,11 +1,11 @@
 /*
-* This example shows basic connection, using Axon internal tools
-* Synapse provides connection between two points
+* This example shows basic server, using Axon internal tools.
+* Synapse provides connection between two points, this one is created in server mode.
 * 
-* This file defines basic server logic, with message handling using Synapse event system
+* This file shows basic server logic and message handling using asynchronous Synapse with event system.
 */
 
-#include <networking/AxonNetwork.hpp>
+#include <networking/AxonLibrary.hpp>
 #include <iostream>
 #include <iomanip>
 
@@ -31,7 +31,9 @@ void onMessageReceived(const Networking::SynapseMessageReceivedEvent& event)
 
 int main()
 {
-	Networking::Synapse<Networking::ConnectionMode::UDP, Networking::SynapseMode::SERVER> serverConnection(10423);
+	Networking::Synapse<
+            Networking::BerkeleyAxonNetworkController<Networking::ConnectionMode::TCP, Networking::SynapseMode::SERVER>
+            > serverConnection(10423);
 	serverConnection.getEventManager().subscribe<Networking::SynapseMessageReceivedEvent>(onMessageReceived);
 
 	std::cout << "Starting Synapse connection" << std::endl;

include/common_macro.h

@@ -1,3 +1,7 @@
+/**
+ *	Defines some useful macro, mostly for C code and backends.
+ */
+
 #ifndef AXONENGINE_COMMON_MACRO_H
 #define AXONENGINE_COMMON_MACRO_H
 

include/custom_utility.h

@@ -1,3 +1,7 @@
+/**
+ * Contains utility types, functions, etc.
+ */
+
 #ifndef CUSTOM_UTILITY_H
 #define CUSTOM_UTILITY_H
 
@@ -6,8 +10,18 @@
 #else
 #include <stdint.h>
 #endif
-// Define alias for uint64_t to be used instead of size_t
-//  as size_t may have different size on different machines (i.e. x86 vs x64)
+
+#include "common_macro.h"
+
+/**
+* Define alias for uint64_t to be used instead of size_t
+* as size_t may have different size on different machines (i.e. x86 vs x64)
+*/
 typedef uint64_t size64_t;
+struct Socket
+{
+    SOCKET_T		socket;
+    SOCKADDR_IN_T	conn;
+};
 
 #endif //CUSTOM_UTILITY_H

include/netconfig.h

@@ -1,4 +1,4 @@
 #pragma once
 
 #define SYNAPSE_PAYLOAD_SIZE_MAX 16
-#define SYNAPSE_MESSAGE_SIZE_MAX SYNAPSE_PAYLOAD_SIZE_MAX + 16 + 64
+#define SYNAPSE_MESSAGE_SIZE_MAX (SYNAPSE_PAYLOAD_SIZE_MAX + 16 + 64)

libraries/AxonUtility.h

@@ -3,16 +3,19 @@
 
 #include <common_macro.h>
 
-#if defined(MSVC) || defined(__GNUC__) || defined(__clang__)
+#if defined(MSVC) || defined(__GNUC__) || defined(__clang__) || defined(WINDOWS_PLATFORM)
 #define GETTER [[nodiscard("Ignoring getter return value is not allowed. For god's sake, have some respect!")]]
 #else
 #define GETTER
 #endif
 
 #if defined(WINDOWS_PLATFORM)
-#define GETTER
 #if defined(AXON_LIB)
+#if defined(AXON_STATIC)
+#define AXON_DECLSPEC
+#else
 #define AXON_DECLSPEC __declspec(dllexport)
+#endif
 #else
 #define AXON_DECLSPEC __declspec(dllimport)
 #endif
@@ -30,3 +33,4 @@
 
 #define WGETTER GETTER_WNE
 #endif
+

libraries/CMakeLists.txt

@@ -5,5 +5,6 @@ message(STATUS "Searching for build config in ${V_GLOB}")
 
 set (CMAKE_POSITION_INDEPENDENT_CODE ON)
 set (COMMON_SRC "AxonUtility.h" PARENT_SCOPE)
+set (LIBS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 add_all_subdirs()

libraries/backends/CMakeLists.txt

@@ -1,7 +1,8 @@
-project ("AxonEngine.libraries")
+project ("AxonEngine.libraries.backends")
 
 file(GLOB_RECURSE SOURCES "*.c" "*.h" "*.cpp" "*.hpp")
 add_library(backends STATIC ${SOURCES})
 
-target_include_directories(backends PUBLIC "${CMAKE_HOME_DIRECTORY}/libraries")
+target_include_directories(backends PUBLIC ${LIBS_DIR})
 target_include_directories(backends PUBLIC "${CMAKE_HOME_DIRECTORY}/common")
+target_compile_definitions(backends PUBLIC AXON_LIB)

libraries/backends/backend.cpp

@@ -30,12 +30,12 @@ template <> uint8_t initialize_server<SOCK_DGRAM>(Socket& socket, uint32_t port)
     return create_udp_server(&socket.conn, &socket.socket, port);
 }
 
-template <> uint8_t initialize_client<SOCK_STREAM>(Socket& socket, const char* hostname, uint32_t port)
+template <> uint8_t initialize_client<SOCK_STREAM>(Socket& socket, const char* hostname, const uint32_t port)
 {
     return connect_tcp_client(&socket.conn, &socket.socket, hostname, port);
 }
 
-template <> uint8_t initialize_client<SOCK_DGRAM>(Socket& socket, const char* hostname, uint32_t port)
+template <> uint8_t initialize_client<SOCK_DGRAM>(Socket& socket, const char* hostname, const uint32_t port)
 {
     return connect_udp_client(&socket.conn, &socket.socket, hostname, port);
 }

libraries/backends/backend.hpp

@@ -1,27 +1,23 @@
+/**
+ * backend library.
+ * Contains functions for protocol-independent socket functions usage. Works with Berkeley sockets.
+ */
+
 #pragma once
 
 #ifdef __cplusplus
 extern "C" {
 #endif
-#if defined(USE_BERKELEY)
-#include "berkeley/basic_networking.h"
-#else
-	/* DEFAULT */
-#endif
-
 #include "berkeley/basic_networking.h"
+#include "custom_utility.h"
 #ifdef __cplusplus
 }
 #endif
 
-template <uint8_t> int32_t send_message(const Socket& socket, const void* message, size_t size);
-
-template <uint8_t> int32_t recv_message(Socket& socket, void* buffer, size_t size_allocated);
-
-template <uint8_t> uint8_t initialize_server(Socket& socket, uint32_t port);
-
-template <uint8_t> uint8_t initialize_client(Socket& socket, const char* hostname, uint32_t port);
-
+template <uint8_t> int32_t send_message(const Socket& socket, const void* message, size_t size) = delete;
+template <uint8_t> int32_t recv_message(Socket& socket, void* buffer, size_t size_allocated) = delete;
+template <uint8_t> uint8_t initialize_server(Socket& socket, uint32_t port) = delete;
+template <uint8_t> uint8_t initialize_client(Socket& socket, const char* hostname, uint32_t port) = delete;
 template <uint8_t> void finalize(Socket& socket);
 
 template <> int32_t send_message<SOCK_STREAM>(const Socket&, const void*, size_t);
@@ -33,6 +29,8 @@ template <> int32_t recv_message<SOCK_DGRAM>(Socket&, void*, size_t);
 template <> uint8_t initialize_server<SOCK_STREAM>(Socket&, uint32_t);
 template <> uint8_t initialize_server<SOCK_DGRAM>(Socket&, uint32_t);
 
+template <> uint8_t initialize_client<SOCK_STREAM>(Socket&, const char*, uint32_t);
+template <> uint8_t initialize_client<SOCK_DGRAM>(Socket&, const char*, uint32_t);
 
 template <> void finalize<SOCK_STREAM>(Socket &);
 template <> void finalize<SOCK_DGRAM>(Socket &);

libraries/backends/berkeley/basic_networking.h

@@ -1,4 +1,4 @@
-/*
+/**
 * Can be used as template for any other backends
 * 
 * Defines some low-level socket logic. Direct usage is not recommended
@@ -12,12 +12,6 @@
 #include "udp/udp_connection.h"
 #include "tcp/tcp_connection.h"
 
-struct Socket
-{
-	SOCKET_T		socket;
-	SOCKADDR_IN_T	conn;
-};
-
 #endif
 
 /* basic_networking.h */

libraries/backends/berkeley/master_include.h

@@ -1,11 +1,21 @@
+/**
+ * Header, that aggregates some includes for every other berkeley backend source file
+ */
+
 #ifndef MASTER_INCLUDE_H
 #define MASTER_INCLUDE_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include <common_macro.h>
 #include <netconfig.h>
-
-/* common */
-
 #include <stdio.h>
 #include <stdlib.h>
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif