70 lines
2.1 KiB
C++
70 lines
2.1 KiB
C++
|
//
|
||
|
|
// handler_invoke_hook.hpp
|
||
|
|
// ~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
//
|
||
|
|
// Copyright (c) 2003-2006 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_INVOKE_HOOK_HPP
|
||
|
|
#define ASIO_HANDLER_INVOKE_HOOK_HPP
|
||
|
|
|
||
|
|
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||
|
|
# pragma once
|
||
|
|
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
|
||
|
|
|
||
|
|
#include "asio/detail/push_options.hpp"
|
||
|
|
|
||
|
|
namespace asio {
|
||
|
|
|
||
|
|
/// Default invoke function for handlers.
|
||
|
|
/**
|
||
|
|
* Completion handlers for asynchronous operations are invoked by the
|
||
|
|
* io_service associated with the corresponding object (e.g. a socket or
|
||
|
|
* deadline_timer). Certain guarantees are made on when the handler may be
|
||
|
|
* invoked, in particular that a handler can only be invoked from a thread that
|
||
|
|
* is currently calling asio::io_service::run() on the corresponding
|
||
|
|
* io_service object. Handlers may subsequently be invoked through other
|
||
|
|
* objects (such as asio::strand objects) that provide additional
|
||
|
|
* guarantees.
|
||
|
|
*
|
||
|
|
* When asynchronous operations are composed from other asynchronous
|
||
|
|
* operations, all intermediate handlers should be invoked using the same
|
||
|
|
* method as the final handler. This is required to ensure that user-defined
|
||
|
|
* objects are not accessed in a way that may violate the guarantees. This
|
||
|
|
* hooking function ensures that the invoked method used for the final handler
|
||
|
|
* is accessible at each intermediate step.
|
||
|
|
*
|
||
|
|
* Implement asio_handler_invoke for your own handlers to specify a custom
|
||
|
|
* invocation strategy.
|
||
|
|
*
|
||
|
|
* This default implementation is simply:
|
||
|
|
* @code
|
||
|
|
* function();
|
||
|
|
* @endcode
|
||
|
|
*
|
||
|
|
* @par Example:
|
||
|
|
* @code
|
||
|
|
* class my_handler;
|
||
|
|
*
|
||
|
|
* template <typename Function>
|
||
|
|
* void asio_handler_invoke(Function function, my_handler* context)
|
||
|
|
* {
|
||
|
|
* context->strand_.dispatch(function);
|
||
|
|
* }
|
||
|
|
* @endcode
|
||
|
|
*/
|
||
|
|
template <typename Function>
|
||
|
|
inline void asio_handler_invoke(Function function, ...)
|
||
|
|
{
|
||
|
|
function();
|
||
|
|
}
|
||
|
|
|
||
|
|
} // namespace asio
|
||
|
|
|
||
|
|
#include "asio/detail/pop_options.hpp"
|
||
|
|
|
||
|
|
#endif // ASIO_HANDLER_INVOKE_HOOK_HPP
|