UT_BoostAsio.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_BoostAsio.h
 *
 * COMMENTS:
 *
 */

#ifndef __UT_BOOSTASIO_H__
#define __UT_BOOSTASIO_H__

#include "UT_API.h"

#include <SYS/SYS_Pragma.h>

// Enable this if you need to track asio handlers.
#if UT_ASSERT_LEVEL > 0
//#define BOOST_ASIO_ENABLE_HANDLER_TRACKING
#endif

// This is required for Windows. We are treating a warning that boost asio
// generates as an error which causes the build to fail.
SYS_PRAGMA_PUSH_WARN()
SYS_PRAGMA_DISABLE_OVERLOADED_VIRTUAL()

#include <hboost/asio.hpp>

SYS_PRAGMA_POP_WARN()

// This is a poor mans version of handler tracking. When boost gets bumped up
// to a version that has handler tracking swap this out for the boost asio
// handler tracking macros.
#ifdef BOOST_ASIO_ENABLE_HANDLER_TRACKING
#define ASIO_HANDLER_LOCATION                                                   \
        UTdebugFormat("{}", __func__);
#else
#define ASIO_HANDLER_LOCATION
#endif

// TCP type alias
using ASIO_TCPSocket = hboost::asio::ip::tcp::socket;
using ASIO_TCPEndpoint = hboost::asio::ip::tcp::endpoint;
using ASIO_TCPAcceptor = hboost::asio::ip::tcp::acceptor;
using ASIO_TCPResolver = hboost::asio::ip::tcp::resolver;

// UDP type alias
using ASIO_UDPSocket = hboost::asio::ip::udp::socket;
using ASIO_UDPEndpoint = hboost::asio::ip::udp::endpoint;
using ASIO_UDPResolver = hboost::asio::ip::udp::resolver;

// IP Address alias
using ASIO_IPAddress = hboost::asio::ip::address;
using ASIO_IPAddressV4 = hboost::asio::ip::address_v4;
using ASIO_IPAddressV6 = hboost::asio::ip::address_v6;
using ASIO_IPNetworkV4 = hboost::asio::ip::network_v4;
using ASIO_IPNetworkV6 = hboost::asio::ip::network_v6;

// Buffers
using ASIO_ConstBuffer = hboost::asio::const_buffer;
using ASIO_MutableBuffer = hboost::asio::mutable_buffer;
using ASIO_StreamBuffer = hboost::asio::streambuf;
template <typename T, typename Allocator = std::allocator<T>>
using ASIO_DynamicVectorBuffer = hboost::asio::dynamic_vector_buffer<T, Allocator>;

// Timers
using ASIO_DeadlineTimer = hboost::asio::deadline_timer;
using ASIO_SystemTimer = hboost::asio::system_timer;

using ASIO_IOStrand = hboost::asio::io_context::strand;

using ASIO_IOContext = hboost::asio::io_context;
template <typename ExecutorT>
using ASIO_ExecutorWorkGuard = hboost::asio::executor_work_guard<ExecutorT>;

using ASIO_AnyExecutor = hboost::asio::any_io_executor;

// Houdini Main IO context.
UT_API ASIO_IOContext::executor_type UThoudiniIOExecutor();

// Extensions to the boost.asio library (i.e. sendfile support).
#include "UT_BoostAsioExt.h"

#endif // __UT_BOOSTASIO_H__