The following platform and compiler combinations are regularly tested:
The following platforms may also work:
__USE_W32_SOCKETS
must be defined.)
The following libraries must be available in order to link programs that use Asio:
spawn()
to launch coroutines.
read_until()
or async_read_until()
overloads that take a boost::regex
parameter.
Furthermore, some of the examples also require Boost.Date_Time or Boost.Serialization libraries.
Note | |
---|---|
With MSVC or Borland C++ you may want to add |
By default, Asio is a header-only library. However, some developers may prefer
to build Asio using separately compiled source code. To do this, add #include
<asio/impl/src.hpp>
to one (and only one) source file in a program,
then build the program with ASIO_SEPARATE_COMPILATION
defined
in the project/compiler settings. Alternatively, ASIO_DYN_LINK
may be defined to build a separately-compiled Asio as part of a shared library.
If using Asio's SSL support, you will also need to add #include <asio/ssl/impl/src.hpp>
.
If the boost directory (e.g. the directory called boost_1_34_1
)
is in the same directory as the asio source kit, then you may configure asio
by simply going:
./configure
in the root directory of the asio source kit. Note that configure will always use the most recent boost version it knows about (i.e. 1.34.1) in preference to earlier versions, if there is more than one version present.
If the boost directory is in some other location, then you need to specify this directory when running configure:
./configure --with-boost=path_to_boost
When specifying the boost directory in this way you should ensure that you use an absolute path.
To build the examples, simply run make
in the root directory of
the asio source kit. To also build and run the unit tests, to confirm that
asio is working correctly, run make check
.
To build using the MSVC 9.0 (or later) command line compiler, perform the following steps in a Command Prompt window:
boost_1_34_1
) is not
in the same directory as the asio source kit, then specify the location
of boost by running a command similar to set BOOSTDIR=path_to_boost
.
Ensure that you specify an absolute path.
src
directory.
nmake -f Makefile.msc
.
nmake -f Makefile.msc check
to run a suite
of tests to confirm that asio is working correctly.
To build using the MinGW g++ compiler from the command line, perform the following steps in a Command Prompt window:
boost_1_34_1
) is not
in the same directory as the asio source kit, then specify the location
of boost by running a command similar to set BOOSTDIR=path_to_boost
.
Ensure that you specify an absolute path using forward slashes
(i.e. c:/projects/boost_1_34_1
rather than c:\projects\boost_1_34_1
).
src
directory.
make -f Makefile.mgw
.
make -f Makefile.mgw check
to run a suite
of tests to confirm that asio is working correctly.
Note | |
---|---|
The above instructions do not work when building inside MSYS. If you want
to build using MSYS, you should use |
The macros listed in the table below may be used to control the behaviour of Asio.
Macro |
Description |
---|---|
|
Enables Asio's buffer debugging support, which can help identify when invalid buffers are used in read or write operations (e.g. if a std::string object being written is destroyed before the write operation completes).
When using Microsoft Visual C++ 11.0 or later, this macro is defined
automatically if the compiler's iterator debugging support is enabled,
unless
When using g++, this macro is defined automatically if standard library
debugging is enabled ( |
|
Explictly disables Asio's buffer debugging support. |
|
Explicitly disables |
|
Explicitly disables |
|
Explicitly disables |
|
Explicitly disables |
|
Explicitly disables I/O completion ports support on Windows, forcing
the use of a |
|
Explicitly disables Asio's threading support, independent of whether or not Boost supports threads. |
|
By default, Asio will automatically define |
|
By default, Asio will automatically define |
|
When compiling for Windows using Microsoft Visual C++ or Borland
C++, Asio will automatically link in the necessary Windows SDK libraries
for sockets support (i.e. |
|
Enables use of the
The * It will only cancel asynchronous operations that were initiated in the current thread. * It can appear to complete without error, but the request to cancel the unfinished operations may be silently ignored by the operating system. Whether it works or not seems to depend on the drivers that are installed. For portable cancellation, consider using one of the following alternatives: * Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP. * Use the socket object's close() function to simultaneously cancel the outstanding operations and close the socket. |
|
Disables uses of the |
|
Determines the number of buckets in asio's internal Some examples:
* Defining
* Defining |
|
The service template parameters, and the corresponding classes, are
disabled by default. For example, instead of |
A mailing list specifically for Asio may be found on SourceForge.net. Newsgroup access is provided via Gmane.
Users are encouraged to share examples, tips and FAQs on the Asio wiki, which is located at http://think-async.com/Asio/.