105 lines
3.3 KiB
C++
105 lines
3.3 KiB
C++
//
|
|
// handler_alloc_hook.hpp
|
|
// ~~~~~~~~~~~~~~~~~~~~~~
|
|
//
|
|
// Copyright (c) 2003-2023 Christopher M. Kohlhoff (chris at kohlhoff dot com)
|
|
//
|
|
// 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 ASIO_HANDLER_ALLOC_HOOK_HPP
|
|
#define ASIO_HANDLER_ALLOC_HOOK_HPP
|
|
|
|
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
|
# pragma once
|
|
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
|
|
|
#include "asio/detail/config.hpp"
|
|
#include <cstddef>
|
|
|
|
#include "asio/detail/push_options.hpp"
|
|
|
|
namespace asio {
|
|
|
|
#if defined(ASIO_NO_DEPRECATED)
|
|
|
|
// Places in asio that would have previously called the allocate or deallocate
|
|
// hooks to manage memory, now call them only to check whether the result types
|
|
// are these types. If the result is not the correct type, it indicates that
|
|
// the user code still has the old hooks in place, and if so we want to trigger
|
|
// a compile error.
|
|
enum asio_handler_allocate_is_no_longer_used {};
|
|
enum asio_handler_deallocate_is_no_longer_used {};
|
|
|
|
typedef asio_handler_allocate_is_no_longer_used
|
|
asio_handler_allocate_is_deprecated;
|
|
typedef asio_handler_deallocate_is_no_longer_used
|
|
asio_handler_deallocate_is_deprecated;
|
|
|
|
#else // defined(ASIO_NO_DEPRECATED)
|
|
|
|
typedef void* asio_handler_allocate_is_deprecated;
|
|
typedef void asio_handler_deallocate_is_deprecated;
|
|
|
|
#endif // defined(ASIO_NO_DEPRECATED)
|
|
|
|
/// (Deprecated: Use the associated_allocator trait.) Default allocation
|
|
/// function for handlers.
|
|
/**
|
|
* Asynchronous operations may need to allocate temporary objects. Since
|
|
* asynchronous operations have a handler function object, these temporary
|
|
* objects can be said to be associated with the handler.
|
|
*
|
|
* Implement asio_handler_allocate and asio_handler_deallocate for your own
|
|
* handlers to provide custom allocation for these temporary objects.
|
|
*
|
|
* The default implementation of these allocation hooks uses <tt>::operator
|
|
* new</tt> and <tt>::operator delete</tt>.
|
|
*
|
|
* @note All temporary objects associated with a handler will be deallocated
|
|
* before the upcall to the handler is performed. This allows the same memory to
|
|
* be reused for a subsequent asynchronous operation initiated by the handler.
|
|
*
|
|
* @par Example
|
|
* @code
|
|
* class my_handler;
|
|
*
|
|
* void* asio_handler_allocate(std::size_t size, my_handler* context)
|
|
* {
|
|
* return ::operator new(size);
|
|
* }
|
|
*
|
|
* void asio_handler_deallocate(void* pointer, std::size_t size,
|
|
* my_handler* context)
|
|
* {
|
|
* ::operator delete(pointer);
|
|
* }
|
|
* @endcode
|
|
*/
|
|
ASIO_DECL asio_handler_allocate_is_deprecated
|
|
asio_handler_allocate(std::size_t size, ...);
|
|
|
|
/// Default deallocation function for handlers.
|
|
/**
|
|
* Implement asio_handler_allocate and asio_handler_deallocate for your own
|
|
* handlers to provide custom allocation for the associated temporary objects.
|
|
*
|
|
* The default implementation of these allocation hooks uses <tt>::operator
|
|
* new</tt> and <tt>::operator delete</tt>.
|
|
*
|
|
* @sa asio_handler_allocate.
|
|
*/
|
|
ASIO_DECL asio_handler_deallocate_is_deprecated
|
|
asio_handler_deallocate(void* pointer, std::size_t size, ...);
|
|
|
|
} // namespace asio
|
|
|
|
#include "asio/detail/pop_options.hpp"
|
|
|
|
#if defined(ASIO_HEADER_ONLY)
|
|
# include "asio/impl/handler_alloc_hook.ipp"
|
|
#endif // defined(ASIO_HEADER_ONLY)
|
|
|
|
#endif // ASIO_HANDLER_ALLOC_HOOK_HPP
|