Skip to content

Commit 1cb045d

Browse files
author
Peter Thorson
committed
Add pointers in the docs to new mingw support
1 parent 2a36e41 commit 1cb045d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/faq.dox

+6-1
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,14 @@ To specify the type of an outgoing message, use the frame opcode values listed a
7272
## Dependency Management
7373

7474
### Can WebSocket++ be used without Boost?
75-
Yes. WebSocket++ only uses Boost features as polyfills for C++11 language features and libraries. If you have a C++11 compiler and standard library you can use WebSocket++ without Boost. In most cases setting your build environment to use the C++11 (or later) language dialect is sufficient to enable this mode of use.
75+
Yes. WebSocket++ only uses Boost features as polyfills for C++11 language features and libraries. If you have a C++11 compiler and standard library you can use WebSocket++ without Boost. In most cases setting your build environment to use the C++11 (or later) language dialect is sufficient to enable this mode of use.
7676

7777
With less common compilers (and sometimes very recently release compilers) there may be specific issues with certain libraries that aren't automatically detected by the library. For these situations there are additional defines available to fine tune which C++11 libraries and features are used. TODO: more details about them.
7878

7979
For the iostream/raw transport the C++11 standard library is sufficient. For the Asio based transports, there is no C++11 library that provides the networking capabilaties that Asio does. As such even with a C++11 build system, you will need a standalone copy of Asio to use if Boost Asio is not available.
8080

81+
MinGW users who want to avoid Boost should also consult the nearby question about MinGW compatibility.
82+
8183
### Can WebSocket++ be used with standalone Asio
8284
Yes. The process is the same as used with standalone Asio itself. Define `ASIO_STANDALONE` before including Asio or WebSocket++ headers. You will need to download a copy of the Asio headers separately (http://www.think-async.com) and make sure they are in your build system's include path.
8385

@@ -91,6 +93,9 @@ The `<websocketpp/config/asio.hpp>` and `<websocketpp/config/asio_client.hpp>` h
9193
### Build issues with TLS on recent versions of OS X
9294
Mac OS X ships a severely outdated version of the OpenSSL library. To securely use TLS with WebSocket++ on OS X you will need to install a modern version of OpenSSL via homebrew or compiling from source.
9395

96+
### Can WebSocket++ be used with MinGW
97+
Generally, yes. Note that in C++11 mode MinGW does not currently support the C++11 STL `<thread>` library. WebSocket++ requires a thread/mutex library. Options include Boost thread (the default when a compatible C++11 `<thread>` can't be found) or `mingw-std-threads` (https://github.com/meganz/mingw-std-threads) by including those headers and defining `_WEBSOCKETPP_MINGW_THREAD_`.
98+
9499
## Compression
95100

96101
### How do I use permessage-deflate in version 0.6.0-permessagedeflate and 0.7.0?

0 commit comments

Comments
 (0)