Merge pull request cpp-netlib#374 from glynos/master

Updates to HTTP Client V2 and documentation.

Author: deanberris

CMakeLists.txt

@@ -135,8 +135,8 @@ if(CPP-NETLIB_BUILD_TESTS)
 
   set(GMOCK_ROOT ${CPP-NETLIB_SOURCE_DIR}/deps/gmock)
   set(GMOCK_FOUND ON)
-  set(GMOCK_INCLUDE_DIRS ${GTEST_INCLUDE_DIRS} {${GMOCK_DIR}/include)
-  set(GMOCK_LIBRARY {$GTEST_LIBRARIES} gmock)
+  set(GMOCK_INCLUDE_DIRS ${GTEST_INCLUDE_DIRS} ${GMOCK_ROOT}/include)
+  set(GMOCK_LIBRARY ${GTEST_LIBRARIES} gmock)
   set(GMOCK_MAIN_LIBRARY gmock_main)
   set(GMOCK_BOTH_LIBRARIES ${GMOCK_LIBRARY} ${GMOCK_MAIN_LIBRARY})
 

Doxyfile.in

@@ -130,7 +130,8 @@ FULL_PATH_NAMES        = YES
 
 STRIP_FROM_PATH        = @CMAKE_CURRENT_SOURCE_DIR@/error/src/ \
                          @CMAKE_CURRENT_SOURCE_DIR@/uri/src/ \
-                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/
+                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/concurrency/src/
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 # the path mentioned in the documentation of a class, which tells
@@ -652,7 +653,8 @@ WARN_LOGFILE           =
 
 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/error/ \
                          @CMAKE_CURRENT_SOURCE_DIR@/uri/src/network/ \
-                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/
+                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/concurrency/src/network/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -849,7 +851,8 @@ COLS_IN_ALPHA_INDEX    = 5
 
 IGNORE_PREFIX          = @CMAKE_CURRENT_SOURCE_DIR@/error/src/ \
                          @CMAKE_CURRENT_SOURCE_DIR@/uri/src/ \
-                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/
+                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/concurrency/src/
 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output

concurrency/src/network/concurrency/thread_pool.hpp

@@ -1,12 +1,22 @@
 // Copyright 2010 Dean Michael Berris.
 // Copyright 2012 Google, Inc.
-// Copyright (c) Glyn Matthews 2012, 2013.
+// Copyright (c) Glyn Matthews 2012, 2013, 2014.
 // Distributed under the Boost Software License, Version 1.0.
 // (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
 
-#ifndef NETWORK_CONCURRENCY_THREAD_POOL_HPP_20101020
-#define NETWORK_CONCURRENCY_THREAD_POOL_HPP_20101020
+#ifndef NETWORK_CONCURRENCY_THREAD_POOL_INC
+#define NETWORK_CONCURRENCY_THREAD_POOL_INC
+
+/**
+ * \defgroup concurrency Basic Concurrency Types
+ *
+ * This module contains a simple concurrency types for use inside the
+ * cpp-netlib network libraries.
+ *
+ * \file
+ * \brief Contains a thread_pool type.
+ */
 
 #include <cstddef>
 #include <thread>
@@ -22,20 +32,62 @@ namespace network {
     typedef std::shared_ptr<std::vector<std::thread>> worker_threads_ptr;
     typedef std::shared_ptr<boost::asio::io_service::work> sentinel_ptr;
 
-    struct thread_pool {
-      thread_pool(std::size_t threads = 1,
+    /**
+     * \ingroup concurrency
+     * \class thread_pool network/concurrency/thread_pool.hpp
+     * \brief A very simple thread pool.
+     */
+    class thread_pool {
+
+      thread_pool(thread_pool const&) = delete;
+      thread_pool& operator=(thread_pool const&) = delete;
+
+    public:
+
+      /**
+       * \brief Constructor.
+       * \param thread_count The number of threads in the thread pool.
+       * \param io_service An external io_service.
+       * \param worker_threads An external thread pool.
+       */
+      thread_pool(std::size_t thread_count = 1,
 		  io_service_ptr io_service = io_service_ptr(),
 		  std::vector<std::thread> worker_threads = std::vector<std::thread>());
-      thread_pool(thread_pool const&) = delete;
-      thread_pool(thread_pool && other);
+
+      /**
+       * \brief Move constuctor.
+       * \param other The other thread_pool object.
+       */
+      thread_pool(thread_pool&& other);
+
+      /**
+       * \brief Destructor.
+       */
       ~thread_pool();
 
-      thread_pool& operator=(thread_pool const&) = delete;
-      thread_pool& operator=(thread_pool && other);
+      /**
+       * \brief Swap function.
+       * \param other The other thread_pool object.
+       */
+      void swap(thread_pool& other);
 
+      /**
+       * \brief Move assignment operator.
+       * \param other The other thread_pool object.
+       */
+      thread_pool& operator=(thread_pool&& other);
+
+      /**
+       * \brief Returns the number of threads in the thread pool.
+       * \returns The number of threads in the thread pool.
+       */
       std::size_t const thread_count() const;
-      void post(std::function<void()> f);
-      void swap(thread_pool& other);
+
+      /**
+       * \brief Posts a task to the thread pool.
+       * \param task The task to be executed.
+       */
+      void post(std::function<void()> task);
 
     private:
 
@@ -52,4 +104,4 @@ namespace network {
   }  // namespace concurrency
 }  // namespace network
 
-#endif /* NETWORK_CONCURRENCY_THREAD_POOL_HPP_20101020 */
+#endif // NETWORK_CONCURRENCY_THREAD_POOL_INC

concurrency/src/network/concurrency/thread_pool.ipp

@@ -17,10 +17,10 @@ namespace network {
   namespace concurrency {
 
     struct thread_pool::impl {
-      impl(std::size_t threads = 1,
+      impl(std::size_t thread_count = 1,
 	    io_service_ptr io_service = io_service_ptr(),
 	    std::vector<std::thread> worker_threads = std::vector<std::thread>())
-	: threads_(threads),
+	: thread_count_(thread_count),
 	  io_service_(io_service),
 	  worker_threads_(std::move(worker_threads)),
 	  sentinel_() {
@@ -49,7 +49,7 @@ namespace network {
 	}
 
 	auto local_io_service = io_service_;
-	for (std::size_t counter = 0; counter < threads_; ++counter) {
+	for (std::size_t counter = 0; counter < thread_count_; ++counter) {
 	  worker_threads_.emplace_back([local_io_service]() {
 	      local_io_service->run();
 	    });
@@ -71,23 +71,23 @@ namespace network {
 	}
       }
 
-      std::size_t threads_;
+      std::size_t thread_count_;
       io_service_ptr io_service_;
       std::vector<std::thread> worker_threads_;
       sentinel_ptr sentinel_;
 
     };
 
-  thread_pool::thread_pool(std::size_t threads,
+  thread_pool::thread_pool(std::size_t thread_count,
 			   io_service_ptr io_service,
 			   std::vector<std::thread> worker_threads)
     : pimpl_(new (std::nothrow)
-	     impl(threads, io_service, std::move(worker_threads))) {
+	     impl(thread_count, io_service, std::move(worker_threads))) {
 
   }
 
   std::size_t const thread_pool::thread_count() const {
-    return pimpl_->threads_;
+    return pimpl_->thread_count_;
   }
 
   void thread_pool::post(std::function<void()> f) {

contrib/http_examples/read_headers.cpp

@@ -19,7 +19,7 @@ main(int argc, char *argv[]) {
 
   try {
     http::client client;
-    http::client::request request{network::uri{std::string{argv[1]}}};
+    http::request request{network::uri{std::string{argv[1]}}};
     request.version("1.0");
     request.append_header("Connection", "close");
     request.append_header("User-Agent", "cpp-netlib read_headers example");

contrib/http_examples/simple_wget.cpp

@@ -6,11 +6,11 @@
 
 //[ simple_wget_main
 /*`
-  This is a very basic clone of wget.  It's missing a lot of
+  This is a very basic clone of wget. It's missing a lot of
   features, such as content-type detection, but it does the
   fundamental things the same.
 
-  It demonstrates the use the `uri` and the `http::client`.
+  It demonstrates the use of the `uri` and the `http::client`.
 */
 
 #include <network/http/client.hpp>
@@ -37,7 +37,7 @@ int main(int argc, char* argv[]) {
 
   try {
     http::client client;
-    http::client::request request{network::uri{std::string{argv[1]}}};
+    http::request request{network::uri{std::string{argv[1]}}};
     request.version("1.0");
     request.append_header("Connection", "close");
     request.append_header("User-Agent", "cpp-netlib simple_wget example");

http/src/CMakeLists.txt

@@ -3,8 +3,8 @@
 # Copyright 2012 A. Joel Lamotte ([email protected])
 # Copyright 2011 Google, Inc.
 # Distributed under the Boost Software License, Version 1.0.
-#    (See accompanying file LICENSE_1_0.txt or copy at
-#          http://www.boost.org/LICENSE_1_0.txt)
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
 
 
 include_directories(
@@ -37,22 +37,6 @@ if(NOT CPP-NETLIB_BUILD_SINGLE_LIB)
   add_library(cppnetlib-http-message-wrappers ${CPP-NETLIB_HTTP_MESSAGE_WRAPPERS_SRCS})
 endif()
 
-#set(CPP-NETLIB_HTTP_CLIENT_CONNECTIONS_SRCS
-#    http/client_connections.cpp
-#    http/simple_connection_manager.cpp
-#    http/simple_connection_factory.cpp
-#    http/connection_delegate_factory.cpp
-#    http/client_resolver_delegate.cpp
-#    http/client_resolver_delegate_factory.cpp
-#    http/client_connection_delegates.cpp
-#    http/client_connection_factory.cpp
-#    http/client_async_resolver.cpp
-#    http/client_connection_normal.cpp)
-#
-#if(NOT CPP-NETLIB_BUILD_SINGLE_LIB)
-#  add_library(cppnetlib-http-client-connections ${CPP-NETLIB_HTTP_CLIENT_CONNECTIONS_SRCS})
-#endif()
-
 set(CPP-NETLIB_CONSTANTS_SRCS
     constants.cpp)
 
@@ -70,26 +54,7 @@ if (NOT CPP-NETLIB_BUILD_SINGLE_LIB)
   add_library(cppnetlib-http-server ${CPP-NETLIB_HTTP_SERVER_SRCS})
 endif()
 
-#set(CPP-NETLIB_HTTP_CLIENT_SRCS
-#    http/client.cpp)
-#
-#if(NOT CPP-NETLIB_BUILD_SINGLE_LIB)
-#  add_library(cppnetlib-http-client ${CPP-NETLIB_HTTP_CLIENT_SRCS})
-#  target_link_libraries(cppnetlib-http-client
-#    ${Boost_LIBRARIES}
-#    ${CPP-NETLIB_LOGGING_LIB}
-#    cppnetlib-constants
-#    cppnetlib-uri
-#    cppnetlib-message
-#    cppnetlib-message-wrappers
-#    cppnetlib-message-directives
-#    cppnetlib-http-message
-#    cppnetlib-http-message-wrappers
-#    cppnetlib-http-client-connections
-#    )
-#endif()
-
-
+# HTTP client
 set(CPP-NETLIB_HTTP_V2_CLIENT_SRCS
   ${CMAKE_CURRENT_SOURCE_DIR}/http/v2/client/client.cpp
   ${CMAKE_CURRENT_SOURCE_DIR}/http/v2/client/client_errors.cpp
@@ -99,23 +64,21 @@ target_link_libraries(network-http-v2-client
   ${Boost_LIBRARIES}
   network-uri
   )
+if (OPENSSL_FOUND)
+  target_link_libraries(network-http-v2-client ${OPENSSL_LIBRARIES})
+endif()
 
 # prepend current directory to make paths absolute
 prependToElements( "${CMAKE_CURRENT_SOURCE_DIR}/"
     CPP-NETLIB_HTTP_MESSAGE_SRCS
     CPP-NETLIB_HTTP_MESSAGE_WRAPPERS_SRCS
-#    CPP-NETLIB_HTTP_CLIENT_CONNECTIONS_SRCS
     CPP-NETLIB_CONSTANTS_SRCS
     CPP-NETLIB_HTTP_SERVER_SRCS
-#    CPP-NETLIB_HTTP_CLIENT_SRCS
     CPP-NETLIB_HTTP_V2_CLIENT_SRCS )
 
-
 # propagate sources to parent directory for one-lib-build
 set(CPP-NETLIB_HTTP_MESSAGE_SRCS ${CPP-NETLIB_HTTP_MESSAGE_SRCS} PARENT_SCOPE)
 set(CPP-NETLIB_HTTP_MESSAGE_WRAPPERS_SRCS ${CPP-NETLIB_HTTP_MESSAGE_WRAPPERS_SRCS} PARENT_SCOPE)
-#set(CPP-NETLIB_HTTP_CLIENT_CONNECTIONS_SRCS ${CPP-NETLIB_HTTP_CLIENT_CONNECTIONS_SRCS} PARENT_SCOPE)
-#set(CPP-NETLIB_HTTP_CLIENT_SRCS ${CPP-NETLIB_HTTP_CLIENT_SRCS} PARENT_SCOPE)
 set(CPP-NETLIB_HTTP_SERVER_SRCS ${CPP-NETLIB_HTTP_SERVER_SRCS} PARENT_SCOPE)
 set(CPP-NETLIB_CONSTANTS_SRCS ${CPP-NETLIB_CONSTANTS_SRCS} PARENT_SCOPE)
 set(CPP-NETLIB_HTTP_V2_CLIENT_SRCS ${CPP-NETLIB_HTTP_V2_CLIENT_SRCS} PARENT SCOPE)