annotate DEPENDENCIES/generic/include/boost/asio/detail/winsock_init.hpp @ 133:4acb5d8d80b6 tip

Don't fail environmental check if README.md exists (but .txt and no-suffix don't)
author Chris Cannam
date Tue, 30 Jul 2019 12:25:44 +0100
parents c530137014c0
children
rev   line source
Chris@16 1 //
Chris@16 2 // detail/winsock_init.hpp
Chris@16 3 // ~~~~~~~~~~~~~~~~~~~~~~~
Chris@16 4 //
Chris@101 5 // Copyright (c) 2003-2015 Christopher M. Kohlhoff (chris at kohlhoff dot com)
Chris@16 6 //
Chris@16 7 // Distributed under the Boost Software License, Version 1.0. (See accompanying
Chris@16 8 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Chris@16 9 //
Chris@16 10
Chris@16 11 #ifndef BOOST_ASIO_DETAIL_WINSOCK_INIT_HPP
Chris@16 12 #define BOOST_ASIO_DETAIL_WINSOCK_INIT_HPP
Chris@16 13
Chris@16 14 #if defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 15 # pragma once
Chris@16 16 #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
Chris@16 17
Chris@16 18 #include <boost/asio/detail/config.hpp>
Chris@16 19
Chris@16 20 #if defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
Chris@16 21
Chris@16 22 #include <boost/asio/detail/push_options.hpp>
Chris@16 23
Chris@16 24 namespace boost {
Chris@16 25 namespace asio {
Chris@16 26 namespace detail {
Chris@16 27
Chris@16 28 class winsock_init_base
Chris@16 29 {
Chris@16 30 protected:
Chris@16 31 // Structure to track result of initialisation and number of uses. POD is used
Chris@16 32 // to ensure that the values are zero-initialised prior to any code being run.
Chris@16 33 struct data
Chris@16 34 {
Chris@16 35 long init_count_;
Chris@16 36 long result_;
Chris@16 37 };
Chris@16 38
Chris@16 39 BOOST_ASIO_DECL static void startup(data& d,
Chris@16 40 unsigned char major, unsigned char minor);
Chris@16 41
Chris@16 42 BOOST_ASIO_DECL static void manual_startup(data& d);
Chris@16 43
Chris@16 44 BOOST_ASIO_DECL static void cleanup(data& d);
Chris@16 45
Chris@16 46 BOOST_ASIO_DECL static void manual_cleanup(data& d);
Chris@16 47
Chris@16 48 BOOST_ASIO_DECL static void throw_on_error(data& d);
Chris@16 49 };
Chris@16 50
Chris@16 51 template <int Major = 2, int Minor = 0>
Chris@16 52 class winsock_init : private winsock_init_base
Chris@16 53 {
Chris@16 54 public:
Chris@16 55 winsock_init(bool allow_throw = true)
Chris@16 56 {
Chris@16 57 startup(data_, Major, Minor);
Chris@16 58 if (allow_throw)
Chris@16 59 throw_on_error(data_);
Chris@16 60 }
Chris@16 61
Chris@16 62 winsock_init(const winsock_init&)
Chris@16 63 {
Chris@16 64 startup(data_, Major, Minor);
Chris@16 65 throw_on_error(data_);
Chris@16 66 }
Chris@16 67
Chris@16 68 ~winsock_init()
Chris@16 69 {
Chris@16 70 cleanup(data_);
Chris@16 71 }
Chris@16 72
Chris@16 73 // This class may be used to indicate that user code will manage Winsock
Chris@16 74 // initialisation and cleanup. This may be required in the case of a DLL, for
Chris@16 75 // example, where it is not safe to initialise Winsock from global object
Chris@16 76 // constructors.
Chris@16 77 //
Chris@16 78 // To prevent asio from initialising Winsock, the object must be constructed
Chris@16 79 // before any Asio's own global objects. With MSVC, this may be accomplished
Chris@16 80 // by adding the following code to the DLL:
Chris@16 81 //
Chris@16 82 // #pragma warning(push)
Chris@16 83 // #pragma warning(disable:4073)
Chris@16 84 // #pragma init_seg(lib)
Chris@16 85 // boost::asio::detail::winsock_init<>::manual manual_winsock_init;
Chris@16 86 // #pragma warning(pop)
Chris@16 87 class manual
Chris@16 88 {
Chris@16 89 public:
Chris@16 90 manual()
Chris@16 91 {
Chris@16 92 manual_startup(data_);
Chris@16 93 }
Chris@16 94
Chris@16 95 manual(const manual&)
Chris@16 96 {
Chris@16 97 manual_startup(data_);
Chris@16 98 }
Chris@16 99
Chris@16 100 ~manual()
Chris@16 101 {
Chris@16 102 manual_cleanup(data_);
Chris@16 103 }
Chris@16 104 };
Chris@16 105
Chris@16 106 private:
Chris@16 107 friend class manual;
Chris@16 108 static data data_;
Chris@16 109 };
Chris@16 110
Chris@16 111 template <int Major, int Minor>
Chris@16 112 winsock_init_base::data winsock_init<Major, Minor>::data_;
Chris@16 113
Chris@16 114 // Static variable to ensure that winsock is initialised before main, and
Chris@16 115 // therefore before any other threads can get started.
Chris@16 116 static const winsock_init<>& winsock_init_instance = winsock_init<>(false);
Chris@16 117
Chris@16 118 } // namespace detail
Chris@16 119 } // namespace asio
Chris@16 120 } // namespace boost
Chris@16 121
Chris@16 122 #include <boost/asio/detail/pop_options.hpp>
Chris@16 123
Chris@16 124 #if defined(BOOST_ASIO_HEADER_ONLY)
Chris@16 125 # include <boost/asio/detail/impl/winsock_init.ipp>
Chris@16 126 #endif // defined(BOOST_ASIO_HEADER_ONLY)
Chris@16 127
Chris@16 128 #endif // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
Chris@16 129
Chris@16 130 #endif // BOOST_ASIO_DETAIL_WINSOCK_INIT_HPP