Exclude any_io_executor traits from documentation.
This commit is contained in:
Christopher Kohlhoff
parent
37789151d0
commit
93f87fbdbf
@ -228,6 +228,8 @@ public:
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
#if !defined(GENERATING_DOCUMENTATION)
|
||||||
|
|
||||||
namespace traits {
|
namespace traits {
|
||||||
|
|
||||||
#if !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
|
#if !defined(ASIO_HAS_DEDUCED_EQUALITY_COMPARABLE_TRAIT)
|
||||||
@ -287,6 +289,8 @@ struct prefer_member<any_io_executor, Prop> :
|
|||||||
|
|
||||||
} // namespace traits
|
} // namespace traits
|
||||||
|
|
||||||
|
#endif // !defined(GENERATING_DOCUMENTATION)
|
||||||
|
|
||||||
#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT)
|
#endif // defined(ASIO_USE_TS_EXECUTOR_AS_DEFAULT)
|
||||||
|
|
||||||
} // namespace asio
|
} // namespace asio
|
||||||
|
|||||||
@ -130713,503 +130713,6 @@ Convert to POSIX duration type.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
[section:traits__equality_comparable_lt__any_io_executor__gt_ traits::equality_comparable< any_io_executor >]
|
|
||||||
|
|
||||||
[indexterm1 asio.indexterm.traits__equality_comparable_lt__any_io_executor__gt_..traits::equality_comparable< any_io_executor >]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template<>
|
|
||||||
struct equality_comparable< any_io_executor >
|
|
||||||
|
|
||||||
|
|
||||||
[heading Data Members]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.traits__equality_comparable_lt__any_io_executor__gt_.is_noexcept [*is_noexcept]] [static]]
|
|
||||||
[]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.traits__equality_comparable_lt__any_io_executor__gt_.is_valid [*is_valid]] [static]]
|
|
||||||
[]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[section:is_noexcept traits::equality_comparable< any_io_executor >::is_noexcept]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__equality_comparable_lt__any_io_executor__gt_.is_noexcept..is_noexcept..traits::equality_comparable< any_io_executor >]
|
|
||||||
|
|
||||||
static const bool is_noexcept = true;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[section:is_valid traits::equality_comparable< any_io_executor >::is_valid]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__equality_comparable_lt__any_io_executor__gt_.is_valid..is_valid..traits::equality_comparable< any_io_executor >]
|
|
||||||
|
|
||||||
static const bool is_valid = true;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
[section:traits__execute_member_lt__any_io_executor_comma__F__gt_ traits::execute_member< any_io_executor, F >]
|
|
||||||
|
|
||||||
[indexterm1 asio.indexterm.traits__execute_member_lt__any_io_executor_comma__F__gt_..traits::execute_member< any_io_executor, F >]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template<
|
|
||||||
typename F>
|
|
||||||
struct execute_member< any_io_executor, F >
|
|
||||||
|
|
||||||
|
|
||||||
[heading Types]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
|
|
||||||
[[link asio.reference.traits__execute_member_lt__any_io_executor_comma__F__gt_.result_type [*result_type]]]
|
|
||||||
[]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Data Members]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.traits__execute_member_lt__any_io_executor_comma__F__gt_.is_noexcept [*is_noexcept]] [static]]
|
|
||||||
[]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.traits__execute_member_lt__any_io_executor_comma__F__gt_.is_valid [*is_valid]] [static]]
|
|
||||||
[]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[section:is_noexcept traits::execute_member< any_io_executor, F >::is_noexcept]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__execute_member_lt__any_io_executor_comma__F__gt_.is_noexcept..is_noexcept..traits::execute_member< any_io_executor, F >]
|
|
||||||
|
|
||||||
static const bool is_noexcept = false;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[section:is_valid traits::execute_member< any_io_executor, F >::is_valid]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__execute_member_lt__any_io_executor_comma__F__gt_.is_valid..is_valid..traits::execute_member< any_io_executor, F >]
|
|
||||||
|
|
||||||
static const bool is_valid = true;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[section:result_type traits::execute_member< any_io_executor, F >::result_type]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__execute_member_lt__any_io_executor_comma__F__gt_.result_type..result_type..traits::execute_member< any_io_executor, F >]
|
|
||||||
|
|
||||||
typedef void result_type;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
[section:traits__prefer_member_lt__any_io_executor_comma__Prop__gt_ traits::prefer_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
[indexterm1 asio.indexterm.traits__prefer_member_lt__any_io_executor_comma__Prop__gt_..traits::prefer_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template<
|
|
||||||
typename ``[link asio.reference.Prop Prop]``>
|
|
||||||
struct prefer_member< any_io_executor, Prop >
|
|
||||||
|
|
||||||
|
|
||||||
[heading Types]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
|
|
||||||
[[link asio.reference.traits__prefer_member_lt__any_io_executor_comma__Prop__gt_.result_type [*result_type]]]
|
|
||||||
[]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[section:result_type traits::prefer_member< any_io_executor, Prop >::result_type]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__prefer_member_lt__any_io_executor_comma__Prop__gt_.result_type..result_type..traits::prefer_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
typedef any_io_executor result_type;
|
|
||||||
|
|
||||||
|
|
||||||
[heading Member Functions]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.any_io_executor [*any_io_executor]] [constructor]]
|
|
||||||
[Default constructor.
|
|
||||||
[hr]
|
|
||||||
Construct in an empty state. Equivalent effects to default constructor.
|
|
||||||
[hr]
|
|
||||||
Copy constructor.
|
|
||||||
[hr]
|
|
||||||
Move constructor.
|
|
||||||
[hr]
|
|
||||||
Construct to point to the same target as another any_executor.
|
|
||||||
[hr]
|
|
||||||
Construct a polymorphic wrapper for the specified executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.context [*context]]]
|
|
||||||
[Obtain the underlying execution context. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.execute [*execute]]]
|
|
||||||
[Execute the function on the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_bool [*operator bool]]]
|
|
||||||
[Determine whether the wrapper has a target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_eq_ [*operator=]]]
|
|
||||||
[Assignment operator.
|
|
||||||
[hr]
|
|
||||||
Move assignment operator.
|
|
||||||
[hr]
|
|
||||||
Assignment operator that sets the polymorphic wrapper to the empty state. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.prefer [*prefer]]]
|
|
||||||
[Obtain a polymorphic wrapper with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.query [*query]]]
|
|
||||||
[Obtain the value associated with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.require [*require]]]
|
|
||||||
[Obtain a polymorphic wrapper with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.swap [*swap]]]
|
|
||||||
[Swap targets with another polymorphic wrapper. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.target [*target]]]
|
|
||||||
[Get a pointer to the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.target_type [*target_type]]]
|
|
||||||
[Get the type of the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor._any_io_executor [*~any_io_executor]] [destructor]]
|
|
||||||
[Destructor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Related Functions]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_not__eq_ [*operator!=]]]
|
|
||||||
[Inequality operator. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_eq__eq_ [*operator==]]]
|
|
||||||
[Equality operator. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
The `any_io_executor` type is a polymorphic executor that supports the set of properties required by I/O objects. It is defined as the [link asio.reference.execution__any_executor `execution::any_executor`] class template parameterised as follows:
|
|
||||||
|
|
||||||
execution::any_executor<
|
|
||||||
execution::context_as_t<execution_context&>,
|
|
||||||
execution::blocking_t::never_t,
|
|
||||||
execution::prefer_only<execution::blocking_t::possibly_t>,
|
|
||||||
execution::prefer_only<execution::outstanding_work_t::tracked_t>,
|
|
||||||
execution::prefer_only<execution::outstanding_work_t::untracked_t>,
|
|
||||||
execution::prefer_only<execution::relationship_t::fork_t>,
|
|
||||||
execution::prefer_only<execution::relationship_t::continuation_t>
|
|
||||||
>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
[section:traits__query_member_lt__any_io_executor_comma__Prop__gt_ traits::query_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
[indexterm1 asio.indexterm.traits__query_member_lt__any_io_executor_comma__Prop__gt_..traits::query_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template<
|
|
||||||
typename ``[link asio.reference.Prop Prop]``>
|
|
||||||
struct query_member< any_io_executor, Prop >
|
|
||||||
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
[section:traits__require_member_lt__any_io_executor_comma__Prop__gt_ traits::require_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
[indexterm1 asio.indexterm.traits__require_member_lt__any_io_executor_comma__Prop__gt_..traits::require_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template<
|
|
||||||
typename ``[link asio.reference.Prop Prop]``>
|
|
||||||
struct require_member< any_io_executor, Prop >
|
|
||||||
|
|
||||||
|
|
||||||
[heading Types]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
|
|
||||||
[[link asio.reference.traits__require_member_lt__any_io_executor_comma__Prop__gt_.result_type [*result_type]]]
|
|
||||||
[]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[section:result_type traits::require_member< any_io_executor, Prop >::result_type]
|
|
||||||
|
|
||||||
[indexterm2 asio.indexterm.traits__require_member_lt__any_io_executor_comma__Prop__gt_.result_type..result_type..traits::require_member< any_io_executor, Prop >]
|
|
||||||
|
|
||||||
typedef any_io_executor result_type;
|
|
||||||
|
|
||||||
|
|
||||||
[heading Member Functions]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.any_io_executor [*any_io_executor]] [constructor]]
|
|
||||||
[Default constructor.
|
|
||||||
[hr]
|
|
||||||
Construct in an empty state. Equivalent effects to default constructor.
|
|
||||||
[hr]
|
|
||||||
Copy constructor.
|
|
||||||
[hr]
|
|
||||||
Move constructor.
|
|
||||||
[hr]
|
|
||||||
Construct to point to the same target as another any_executor.
|
|
||||||
[hr]
|
|
||||||
Construct a polymorphic wrapper for the specified executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.context [*context]]]
|
|
||||||
[Obtain the underlying execution context. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.execute [*execute]]]
|
|
||||||
[Execute the function on the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_bool [*operator bool]]]
|
|
||||||
[Determine whether the wrapper has a target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_eq_ [*operator=]]]
|
|
||||||
[Assignment operator.
|
|
||||||
[hr]
|
|
||||||
Move assignment operator.
|
|
||||||
[hr]
|
|
||||||
Assignment operator that sets the polymorphic wrapper to the empty state. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.prefer [*prefer]]]
|
|
||||||
[Obtain a polymorphic wrapper with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.query [*query]]]
|
|
||||||
[Obtain the value associated with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.require [*require]]]
|
|
||||||
[Obtain a polymorphic wrapper with the specified property. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.swap [*swap]]]
|
|
||||||
[Swap targets with another polymorphic wrapper. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.target [*target]]]
|
|
||||||
[Get a pointer to the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.target_type [*target_type]]]
|
|
||||||
[Get the type of the target executor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor._any_io_executor [*~any_io_executor]] [destructor]]
|
|
||||||
[Destructor. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
[heading Related Functions]
|
|
||||||
[table
|
|
||||||
[[Name][Description]]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_not__eq_ [*operator!=]]]
|
|
||||||
[Inequality operator. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
[
|
|
||||||
[[link asio.reference.any_io_executor.operator_eq__eq_ [*operator==]]]
|
|
||||||
[Equality operator. ]
|
|
||||||
]
|
|
||||||
|
|
||||||
]
|
|
||||||
|
|
||||||
The `any_io_executor` type is a polymorphic executor that supports the set of properties required by I/O objects. It is defined as the [link asio.reference.execution__any_executor `execution::any_executor`] class template parameterised as follows:
|
|
||||||
|
|
||||||
execution::any_executor<
|
|
||||||
execution::context_as_t<execution_context&>,
|
|
||||||
execution::blocking_t::never_t,
|
|
||||||
execution::prefer_only<execution::blocking_t::possibly_t>,
|
|
||||||
execution::prefer_only<execution::outstanding_work_t::tracked_t>,
|
|
||||||
execution::prefer_only<execution::outstanding_work_t::untracked_t>,
|
|
||||||
execution::prefer_only<execution::relationship_t::fork_t>,
|
|
||||||
execution::prefer_only<execution::relationship_t::continuation_t>
|
|
||||||
>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[heading Requirements]
|
|
||||||
|
|
||||||
['Header: ][^asio/any_io_executor.hpp]
|
|
||||||
|
|
||||||
['Convenience header: ][^asio.hpp]
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user