Remove std::any (#40)

Remove the config.h

Remove USE_OPENSSL macro from header files

Initialize OpenSSL only once globally

Modify methods of the context

update CMakeLists.txt

Remove some std::dynamic_pointer_cast calls

Author: an-tao

.gitignore

@@ -1,4 +1,4 @@
 .idea
 build
 cmake-build-debug
-trantor/utils/config.h
+.vscode

CMakeLists.txt

@@ -1,27 +1,5 @@
-cmake_minimum_required(VERSION 3.2)
-project(trantor)
-
-if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-#Clang, use c++17
-    set(DEFS "USE_STD_ANY")
-    set(USE_STD_ANY 1)
-    set(CMAKE_CXX_STD_FLAGS c++17)
-else()
-    EXEC_PROGRAM (gcc ARGS "--version | grep '^gcc'|awk '{print $3}' | sed s'/)//g' | sed s'/-.*//g'" OUTPUT_VARIABLE version)
-    MESSAGE(STATUS "This is gcc version:: " ${version})
-    if(version LESS 5.4.0)
-        MESSAGE(STATUS "gcc is too old")
-        stop()
-    elseif(version LESS 7.1.0)
-        set(CMAKE_CXX_STD_FLAGS c++14)
-        MESSAGE(STATUS "c++14")
-    else()
-        set(CMAKE_CXX_STD_FLAGS c++17)
-        set(DEFS "USE_STD_ANY")
-        set(USE_STD_ANY 1)
-        MESSAGE(STATUS "c++17")
-    endif()
-endif()
+CMAKE_MINIMUM_REQUIRED(VERSION 3.2)
+PROJECT(trantor)
 
 # include directories
 INCLUDE_DIRECTORIES(
@@ -33,90 +11,98 @@ INCLUDE_DIRECTORIES(
         /usr/include
 )
 
-if(CMAKE_BUILD_TYPE STREQUAL "")
-    set(CMAKE_BUILD_TYPE Release)
-endif()
-
-set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wall -std=${CMAKE_CXX_STD_FLAGS}")
-set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Wall -std=${CMAKE_CXX_STD_FLAGS}")
-
-
 # lib directories
 LINK_DIRECTORIES(
         ${PROJECT_BINARY_DIR}/
         /usr/local/lib
         /usr/lib
 )
 
-AUX_SOURCE_DIRECTORY(trantor/utils DIR_SRC)
-AUX_SOURCE_DIRECTORY(trantor/net DIR_SRC)
-AUX_SOURCE_DIRECTORY(trantor/net/inner DIR_SRC)
-find_package (OpenSSL)
-if(OpenSSL_FOUND)
-    #add_definitions(-DUSE_OPENSSL)
-    set(DEFS "USE_OPENSSL;${DEFS}")
+SET(public_net_headers
+    trantor/net/EventLoop.h
+    trantor/net/EventLoopThread.h
+    trantor/net/EventLoopThreadPool.h
+    trantor/net/InetAddress.h
+    trantor/net/TcpClient.h
+    trantor/net/TcpConnection.h
+    trantor/net/TcpServer.h
+    trantor/net/callbacks.h)
+    
+SET(public_utils_headers
+    trantor/utils/AsyncFileLogger.h
+    trantor/utils/ConcurrentTaskQueue.h
+    trantor/utils/Date.h
+    trantor/utils/Funcs.h
+    trantor/utils/LockFreeQueue.h
+    trantor/utils/LogStream.h
+    trantor/utils/Logger.h
+    trantor/utils/MsgBuffer.h
+    trantor/utils/NonCopyable.h
+    trantor/utils/ObjectPool.h
+    trantor/utils/SerialTaskQueue.h
+    trantor/utils/TaskQueue.h
+    trantor/utils/TimingWheel.h)
+
+SOURCE_GROUP( "Public API" FILES ${public_net_headers} ${public_utils_headers})
+
+SET(trantor_sources
+    trantor/utils/AsyncFileLogger.cc
+    trantor/utils/ConcurrentTaskQueue.cc
+    trantor/utils/Date.cc
+    trantor/utils/LogStream.cc
+    trantor/utils/Logger.cc
+    trantor/utils/MsgBuffer.cc
+    trantor/utils/SerialTaskQueue.cc
+    trantor/utils/TimingWheel.cc
+    trantor/net/EventLoop.cc
+    trantor/net/EventLoopThread.cc
+    trantor/net/EventLoopThreadPool.cc
+    trantor/net/InetAddress.cc
+    trantor/net/TcpClient.cc
+    trantor/net/TcpServer.cc
+    trantor/net/inner/Acceptor.cc
+    trantor/net/inner/Channel.cc
+    trantor/net/inner/Connector.cc
+    trantor/net/inner/Poller.cc
+    trantor/net/inner/Socket.cc
+    trantor/net/inner/TcpConnectionImpl.cc
+    trantor/net/inner/Timer.cc
+    trantor/net/inner/TimerQueue.cc)
+
+FIND_PACKAGE(OpenSSL)
+IF(OpenSSL_FOUND)
     include_directories(${OPENSSL_INCLUDE_DIR})
-    link_libraries(${OPENSSL_LIBRARIES})
-    AUX_SOURCE_DIRECTORY(trantor/net/ssl DIR_SRC)
-endif()
+    LINK_LIBRARIES(${OPENSSL_LIBRARIES})
+    SET(trantor_sources ${trantor_sources} trantor/net/ssl/SSLConnection.cc)
+ELSE()
+    SET(trantor_sources ${trantor_sources} trantor/net/ssl/SSLConnectionSkipped.cc)
+ENDIF()
 
 IF (CMAKE_SYSTEM_NAME MATCHES "Linux")
-    ADD_LIBRARY(trantor ${DIR_SRC} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/EpollPoller.cc)
+    SET(trantor_sources ${trantor_sources} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/EpollPoller.cc)
     MESSAGE(STATUS "current platform: Linux ")
 ELSEIF (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    MESSAGE(STATUS "current platform: Windows")
+    MESSAGE(FATAL_ERROR "Error: Currently does not support Windows")
 ELSEIF (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
-    ADD_LIBRARY(trantor ${DIR_SRC} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/KQueue.cc)
+    SET(trantor_sources ${trantor_sources} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/KQueue.cc)
     MESSAGE(STATUS "current platform: FreeBSD")
 ELSEIF(CMAKE_SYSTEM_NAME MATCHES "Darwin")
-    #ADD_LIBRARY(trantor ${DIR_SRC} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/PollPoller.cc)
-    ADD_LIBRARY(trantor ${DIR_SRC} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/KQueue.cc)
+    SET(trantor_sources ${trantor_sources} ${PROJECT_SOURCE_DIR}/trantor/net/inner/poller/KQueue.cc)
     MESSAGE(STATUS "current platform: MacOS")
 ELSE ()
     MESSAGE(STATUS "other platform: ${CMAKE_SYSTEM_NAME}")
 ENDIF (CMAKE_SYSTEM_NAME MATCHES "Linux")
 
+ADD_LIBRARY(trantor ${trantor_sources})
+SET_PROPERTY(TARGET trantor PROPERTY CXX_STANDARD 14)
+SET_PROPERTY(TARGET trantor PROPERTY CXX_STANDARD_REQUIRED ON)
+SET_PROPERTY(TARGET trantor PROPERTY CXX_EXTENSIONS OFF)
 
-SET(CONFIG_HEADER "${PROJECT_SOURCE_DIR}/config.h")
-file(WRITE "${CONFIG_HEADER}" "#pragma once\n")
-foreach(loop_var ${DEFS})
-    file(APPEND "${CONFIG_HEADER}" "#define ${loop_var}\n")
-endforeach(loop_var)
-file(APPEND "${CONFIG_HEADER}" "\n")
-
-if(DEFINED USE_STD_ANY)
-
-file(APPEND "${CONFIG_HEADER}" "#include <any>\n")
-file(APPEND "${CONFIG_HEADER}" "using std::any;\n")
-file(APPEND "${CONFIG_HEADER}" "using std::any_cast;\n\n")
-file(APPEND "${CONFIG_HEADER}" "#include <string_view>\n")
-file(APPEND "${CONFIG_HEADER}" "typedef std::string_view string_view;\n\n")
-
-else()
-
-file(APPEND "${CONFIG_HEADER}" "#include <experimental/any>\n")
-file(APPEND "${CONFIG_HEADER}" "using std::experimental::any;\n")
-file(APPEND "${CONFIG_HEADER}" "using std::experimental::any_cast;\n\n")
-file(APPEND "${CONFIG_HEADER}" "#include <experimental/string_view>\n")
-file(APPEND "${CONFIG_HEADER}" "typedef std::experimental::basic_string_view<char> string_view;\n\n")
-
-endif()
-
-EXEC_PROGRAM(${PROJECT_SOURCE_DIR}/update_config.sh ARGS "${CONFIG_HEADER} ${PROJECT_SOURCE_DIR}/trantor/utils/config.h")
-
-if (MAKETEST STREQUAL YES)
+IF (MAKETEST STREQUAL YES)
     ADD_SUBDIRECTORY(trantor/tests)
-endif ()
-
-#install
-
-install(TARGETS trantor DESTINATION lib)
-
-install(DIRECTORY trantor/utils/ DESTINATION include/trantor/utils
-        FILES_MATCHING PATTERN "*.h")
-
-file(GLOB trantor_net_headers "${CMAKE_CURRENT_SOURCE_DIR}/trantor/net/*.h")
-install(FILES ${trantor_net_headers} DESTINATION include/trantor/net)
-
+ENDIF ()
 
+INSTALL(TARGETS trantor DESTINATION lib)
 
+INSTALL(FILES ${public_net_headers} DESTINATION include/trantor/net)
+INSTALL(FILES ${public_utils_headers} DESTINATION include/trantor/utils)

trantor/net/EventLoop.cc

@@ -176,7 +176,7 @@ void EventLoop::abortNotInLoopThread()
 {
     LOG_FATAL << "It is forbidden to run loop on threads other than event-loop "
                  "thread";
-    exit(-1);
+    exit(1);
 }
 void EventLoop::runInLoop(const Func &cb)
 {

trantor/net/TcpClient.cc

@@ -12,9 +12,7 @@
 #include <trantor/net/TcpClient.h>
 
 #include <trantor/utils/Logger.h>
-#ifdef USE_OPENSSL
 #include "ssl/SSLConnection.h"
-#endif
 #include "Connector.h"
 #include "inner/TcpConnectionImpl.h"
 #include <trantor/net/EventLoop.h>
@@ -100,7 +98,7 @@ TcpClient::~TcpClient()
         _loop->runInLoop([conn, loop]() {
             conn->setCloseCallback([loop](const TcpConnectionPtr &connPtr) {
                 loop->queueInLoop([connPtr]() {
-                    std::dynamic_pointer_cast<TcpConnectionImpl>(connPtr)
+                    static_cast<TcpConnectionImpl *>(connPtr.get())
                         ->connectDestroyed();
                 });
             });
@@ -148,9 +146,8 @@ void TcpClient::newConnection(int sockfd)
     _loop->assertInLoopThread();
     InetAddress peerAddr(Socket::getPeerAddr(sockfd));
     InetAddress localAddr(Socket::getLocalAddr(sockfd));
-// TODO poll with zero timeout to double confirm the new connection
-// TODO use make_shared if necessary
-#ifdef USE_OPENSSL
+    // TODO poll with zero timeout to double confirm the new connection
+    // TODO use make_shared if necessary
     std::shared_ptr<TcpConnectionImpl> conn;
     if (_sslCtxPtr)
     {
@@ -164,10 +161,6 @@ void TcpClient::newConnection(int sockfd)
                                                    localAddr,
                                                    peerAddr);
     }
-#else
-    auto conn =
-        std::make_shared<TcpConnectionImpl>(_loop, sockfd, localAddr, peerAddr);
-#endif
     conn->setConnectionCallback(_connectionCallback);
     conn->setRecvMsgCallback(_messageCallback);
     conn->setWriteCompleteCallback(_writeCompleteCallback);
@@ -201,26 +194,10 @@ void TcpClient::removeConnection(const TcpConnectionPtr &conn)
     }
 }
 
-#ifdef USE_OPENSSL
 void TcpClient::enableSSL()
 {
-// init OpenSSL
-#if (OPENSSL_VERSION_NUMBER < 0x10100000L) || \
-    (defined(LIBRESSL_VERSION_NUMBER) &&      \
-     LIBRESSL_VERSION_NUMBER < 0x20700000L)
-    // Initialize OpenSSL once;
-    static std::once_flag once;
-    std::call_once(once, []() {
-        SSL_library_init();
-        ERR_load_crypto_strings();
-        SSL_load_error_strings();
-        OpenSSL_add_all_algorithms();
-    });
-#endif
+    // init OpenSSL
+    initOpenSSL();
     /* Create a new OpenSSL context */
-    _sslCtxPtr =
-        std::shared_ptr<SSL_CTX>(SSL_CTX_new(SSLv23_method()),
-                                 [](SSL_CTX *ctx) { SSL_CTX_free(ctx); });
-    assert(_sslCtxPtr);
+    _sslCtxPtr = newSSLContext();
 }
-#endif

trantor/net/TcpClient.h

@@ -17,23 +17,18 @@
 // Author: Tao An
 
 #pragma once
-#include <trantor/utils/config.h>
 #include <trantor/net/EventLoop.h>
 #include <trantor/net/InetAddress.h>
 #include <trantor/net/TcpConnection.h>
 #include <functional>
 #include <thread>
 #include <atomic>
 #include <signal.h>
-#ifdef USE_OPENSSL
-#include <openssl/ssl.h>
-#include <openssl/err.h>
-#endif
 namespace trantor
 {
 class Connector;
 typedef std::shared_ptr<Connector> ConnectorPtr;
-
+class SSLContext;
 class TcpClient : NonCopyable
 {
   public:
@@ -108,9 +103,7 @@ class TcpClient : NonCopyable
     {
         _writeCompleteCallback = std::move(cb);
     }
-#ifdef USE_OPENSSL
     void enableSSL();
-#endif
 
   private:
     /// Not thread safe, but in loop
@@ -130,9 +123,7 @@ class TcpClient : NonCopyable
     // always in loop thread
     mutable std::mutex _mutex;
     TcpConnectionPtr _connection;  // @GuardedBy _mutex
-#ifdef USE_OPENSSL
-    std::shared_ptr<SSL_CTX> _sslCtxPtr;
-#endif
+    std::shared_ptr<SSLContext> _sslCtxPtr;
     class IgnoreSigPipe
     {
       public:

trantor/net/TcpConnection.h

@@ -13,8 +13,6 @@
  */
 
 #pragma once
-
-#include <trantor/utils/config.h>
 #include <trantor/net/EventLoop.h>
 #include <trantor/net/InetAddress.h>
 #include <trantor/utils/NonCopyable.h>
@@ -59,19 +57,45 @@ class TcpConnection
     virtual void forceClose() = 0;
     virtual EventLoop *getLoop() = 0;
 
-    virtual void setContext(const any &context) = 0;
-    virtual void setContext(any &&context) = 0;
-    virtual const any &getContext() const = 0;
+    /// Set custom data on the connection
+    void setContext(const std::shared_ptr<void> &context)
+    {
+        _contextPtr = context;
+    }
+    void setContext(std::shared_ptr<void> &&context)
+    {
+        _contextPtr = std::move(context);
+    }
 
-    virtual any *getMutableContext() = 0;
+    /// Get custom data from the connection
+    template <typename T>
+    std::shared_ptr<T> getContext() const
+    {
+        return std::static_pointer_cast<T>(_contextPtr);
+    }
 
+    /// Return true if the context is set by user.
+    bool hasContext() const
+    {
+        return (bool)_contextPtr;
+    }
+    
+    /// Clear the context.
+    void clearContext()
+    {
+        _contextPtr.reset();
+    }
+    
     // Call this method to avoid being kicked off by TcpServer, refer to
     // the kickoffIdleConnections method in the TcpServer class.
     virtual void keepAlive() = 0;
     virtual bool isKeepAlive() = 0;
 
     virtual size_t bytesSent() const = 0;
     virtual size_t bytesReceived() const = 0;
+
+  private:
+    std::shared_ptr<void> _contextPtr;
 };
 
 }  // namespace trantor