12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510 |
- //
- // basic_socket_acceptor.hpp
- // ~~~~~~~~~~~~~~~~~~~~~~~~~
- //
- // Copyright (c) 2003-2021 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 BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_HPP
- #define BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_HPP
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
- #include <boost/asio/detail/config.hpp>
- #include <boost/asio/any_io_executor.hpp>
- #include <boost/asio/basic_socket.hpp>
- #include <boost/asio/detail/handler_type_requirements.hpp>
- #include <boost/asio/detail/io_object_impl.hpp>
- #include <boost/asio/detail/non_const_lvalue.hpp>
- #include <boost/asio/detail/throw_error.hpp>
- #include <boost/asio/detail/type_traits.hpp>
- #include <boost/asio/error.hpp>
- #include <boost/asio/execution_context.hpp>
- #include <boost/asio/socket_base.hpp>
- #if defined(BOOST_ASIO_WINDOWS_RUNTIME)
- # include <boost/asio/detail/null_socket_service.hpp>
- #elif defined(BOOST_ASIO_HAS_IOCP)
- # include <boost/asio/detail/win_iocp_socket_service.hpp>
- #else
- # include <boost/asio/detail/reactive_socket_service.hpp>
- #endif
- #if defined(BOOST_ASIO_HAS_MOVE)
- # include <utility>
- #endif // defined(BOOST_ASIO_HAS_MOVE)
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- #if !defined(BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_FWD_DECL)
- #define BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_FWD_DECL
- // Forward declaration with defaulted arguments.
- template <typename Protocol, typename Executor = any_io_executor>
- class basic_socket_acceptor;
- #endif // !defined(BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_FWD_DECL)
- /// Provides the ability to accept new connections.
- /**
- * The basic_socket_acceptor class template is used for accepting new socket
- * connections.
- *
- * @par Thread Safety
- * @e Distinct @e objects: Safe.@n
- * @e Shared @e objects: Unsafe.
- *
- * Synchronous @c accept operations are thread safe, if the underlying
- * operating system calls are also thread safe. This means that it is permitted
- * to perform concurrent calls to synchronous @c accept operations on a single
- * socket object. Other synchronous operations, such as @c open or @c close, are
- * not thread safe.
- *
- * @par Example
- * Opening a socket acceptor with the SO_REUSEADDR option enabled:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), port);
- * acceptor.open(endpoint.protocol());
- * acceptor.set_option(boost::asio::ip::tcp::acceptor::reuse_address(true));
- * acceptor.bind(endpoint);
- * acceptor.listen();
- * @endcode
- */
- template <typename Protocol, typename Executor>
- class basic_socket_acceptor
- : public socket_base
- {
- public:
- /// The type of the executor associated with the object.
- typedef Executor executor_type;
- /// Rebinds the acceptor type to another executor.
- template <typename Executor1>
- struct rebind_executor
- {
- /// The socket type when rebound to the specified executor.
- typedef basic_socket_acceptor<Protocol, Executor1> other;
- };
- /// The native representation of an acceptor.
- #if defined(GENERATING_DOCUMENTATION)
- typedef implementation_defined native_handle_type;
- #elif defined(BOOST_ASIO_WINDOWS_RUNTIME)
- typedef typename detail::null_socket_service<
- Protocol>::native_handle_type native_handle_type;
- #elif defined(BOOST_ASIO_HAS_IOCP)
- typedef typename detail::win_iocp_socket_service<
- Protocol>::native_handle_type native_handle_type;
- #else
- typedef typename detail::reactive_socket_service<
- Protocol>::native_handle_type native_handle_type;
- #endif
- /// The protocol type.
- typedef Protocol protocol_type;
- /// The endpoint type.
- typedef typename Protocol::endpoint endpoint_type;
- /// Construct an acceptor without opening it.
- /**
- * This constructor creates an acceptor without opening it to listen for new
- * connections. The open() function must be called before the acceptor can
- * accept new socket connections.
- *
- * @param ex The I/O executor that the acceptor will use, by default, to
- * dispatch handlers for any asynchronous operations performed on the
- * acceptor.
- */
- explicit basic_socket_acceptor(const executor_type& ex)
- : impl_(0, ex)
- {
- }
- /// Construct an acceptor without opening it.
- /**
- * This constructor creates an acceptor without opening it to listen for new
- * connections. The open() function must be called before the acceptor can
- * accept new socket connections.
- *
- * @param context An execution context which provides the I/O executor that
- * the acceptor will use, by default, to dispatch handlers for any
- * asynchronous operations performed on the acceptor.
- */
- template <typename ExecutionContext>
- explicit basic_socket_acceptor(ExecutionContext& context,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- : impl_(0, 0, context)
- {
- }
- /// Construct an open acceptor.
- /**
- * This constructor creates an acceptor and automatically opens it.
- *
- * @param ex The I/O executor that the acceptor will use, by default, to
- * dispatch handlers for any asynchronous operations performed on the
- * acceptor.
- *
- * @param protocol An object specifying protocol parameters to be used.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- basic_socket_acceptor(const executor_type& ex, const protocol_type& protocol)
- : impl_(0, ex)
- {
- boost::system::error_code ec;
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- boost::asio::detail::throw_error(ec, "open");
- }
- /// Construct an open acceptor.
- /**
- * This constructor creates an acceptor and automatically opens it.
- *
- * @param context An execution context which provides the I/O executor that
- * the acceptor will use, by default, to dispatch handlers for any
- * asynchronous operations performed on the acceptor.
- *
- * @param protocol An object specifying protocol parameters to be used.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- template <typename ExecutionContext>
- basic_socket_acceptor(ExecutionContext& context,
- const protocol_type& protocol,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value,
- defaulted_constraint
- >::type = defaulted_constraint())
- : impl_(0, 0, context)
- {
- boost::system::error_code ec;
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- boost::asio::detail::throw_error(ec, "open");
- }
- /// Construct an acceptor opened on the given endpoint.
- /**
- * This constructor creates an acceptor and automatically opens it to listen
- * for new connections on the specified endpoint.
- *
- * @param ex The I/O executor that the acceptor will use, by default, to
- * dispatch handlers for any asynchronous operations performed on the
- * acceptor.
- *
- * @param endpoint An endpoint on the local machine on which the acceptor
- * will listen for new connections.
- *
- * @param reuse_addr Whether the constructor should set the socket option
- * socket_base::reuse_address.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note This constructor is equivalent to the following code:
- * @code
- * basic_socket_acceptor<Protocol> acceptor(my_context);
- * acceptor.open(endpoint.protocol());
- * if (reuse_addr)
- * acceptor.set_option(socket_base::reuse_address(true));
- * acceptor.bind(endpoint);
- * acceptor.listen();
- * @endcode
- */
- basic_socket_acceptor(const executor_type& ex,
- const endpoint_type& endpoint, bool reuse_addr = true)
- : impl_(0, ex)
- {
- boost::system::error_code ec;
- const protocol_type protocol = endpoint.protocol();
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- boost::asio::detail::throw_error(ec, "open");
- if (reuse_addr)
- {
- impl_.get_service().set_option(impl_.get_implementation(),
- socket_base::reuse_address(true), ec);
- boost::asio::detail::throw_error(ec, "set_option");
- }
- impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
- boost::asio::detail::throw_error(ec, "bind");
- impl_.get_service().listen(impl_.get_implementation(),
- socket_base::max_listen_connections, ec);
- boost::asio::detail::throw_error(ec, "listen");
- }
- /// Construct an acceptor opened on the given endpoint.
- /**
- * This constructor creates an acceptor and automatically opens it to listen
- * for new connections on the specified endpoint.
- *
- * @param context An execution context which provides the I/O executor that
- * the acceptor will use, by default, to dispatch handlers for any
- * asynchronous operations performed on the acceptor.
- *
- * @param endpoint An endpoint on the local machine on which the acceptor
- * will listen for new connections.
- *
- * @param reuse_addr Whether the constructor should set the socket option
- * socket_base::reuse_address.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note This constructor is equivalent to the following code:
- * @code
- * basic_socket_acceptor<Protocol> acceptor(my_context);
- * acceptor.open(endpoint.protocol());
- * if (reuse_addr)
- * acceptor.set_option(socket_base::reuse_address(true));
- * acceptor.bind(endpoint);
- * acceptor.listen();
- * @endcode
- */
- template <typename ExecutionContext>
- basic_socket_acceptor(ExecutionContext& context,
- const endpoint_type& endpoint, bool reuse_addr = true,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- : impl_(0, 0, context)
- {
- boost::system::error_code ec;
- const protocol_type protocol = endpoint.protocol();
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- boost::asio::detail::throw_error(ec, "open");
- if (reuse_addr)
- {
- impl_.get_service().set_option(impl_.get_implementation(),
- socket_base::reuse_address(true), ec);
- boost::asio::detail::throw_error(ec, "set_option");
- }
- impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
- boost::asio::detail::throw_error(ec, "bind");
- impl_.get_service().listen(impl_.get_implementation(),
- socket_base::max_listen_connections, ec);
- boost::asio::detail::throw_error(ec, "listen");
- }
- /// Construct a basic_socket_acceptor on an existing native acceptor.
- /**
- * This constructor creates an acceptor object to hold an existing native
- * acceptor.
- *
- * @param ex The I/O executor that the acceptor will use, by default, to
- * dispatch handlers for any asynchronous operations performed on the
- * acceptor.
- *
- * @param protocol An object specifying protocol parameters to be used.
- *
- * @param native_acceptor A native acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- basic_socket_acceptor(const executor_type& ex,
- const protocol_type& protocol, const native_handle_type& native_acceptor)
- : impl_(0, ex)
- {
- boost::system::error_code ec;
- impl_.get_service().assign(impl_.get_implementation(),
- protocol, native_acceptor, ec);
- boost::asio::detail::throw_error(ec, "assign");
- }
- /// Construct a basic_socket_acceptor on an existing native acceptor.
- /**
- * This constructor creates an acceptor object to hold an existing native
- * acceptor.
- *
- * @param context An execution context which provides the I/O executor that
- * the acceptor will use, by default, to dispatch handlers for any
- * asynchronous operations performed on the acceptor.
- *
- * @param protocol An object specifying protocol parameters to be used.
- *
- * @param native_acceptor A native acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- template <typename ExecutionContext>
- basic_socket_acceptor(ExecutionContext& context,
- const protocol_type& protocol, const native_handle_type& native_acceptor,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- : impl_(0, 0, context)
- {
- boost::system::error_code ec;
- impl_.get_service().assign(impl_.get_implementation(),
- protocol, native_acceptor, ec);
- boost::asio::detail::throw_error(ec, "assign");
- }
- #if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Move-construct a basic_socket_acceptor from another.
- /**
- * This constructor moves an acceptor from one object to another.
- *
- * @param other The other basic_socket_acceptor object from which the move
- * will occur.
- *
- * @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket_acceptor(const executor_type&)
- * constructor.
- */
- basic_socket_acceptor(basic_socket_acceptor&& other) BOOST_ASIO_NOEXCEPT
- : impl_(std::move(other.impl_))
- {
- }
- /// Move-assign a basic_socket_acceptor from another.
- /**
- * This assignment operator moves an acceptor from one object to another.
- *
- * @param other The other basic_socket_acceptor object from which the move
- * will occur.
- *
- * @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket_acceptor(const executor_type&)
- * constructor.
- */
- basic_socket_acceptor& operator=(basic_socket_acceptor&& other)
- {
- impl_ = std::move(other.impl_);
- return *this;
- }
- // All socket acceptors have access to each other's implementations.
- template <typename Protocol1, typename Executor1>
- friend class basic_socket_acceptor;
- /// Move-construct a basic_socket_acceptor from an acceptor of another
- /// protocol type.
- /**
- * This constructor moves an acceptor from one object to another.
- *
- * @param other The other basic_socket_acceptor object from which the move
- * will occur.
- *
- * @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket_acceptor(const executor_type&)
- * constructor.
- */
- template <typename Protocol1, typename Executor1>
- basic_socket_acceptor(basic_socket_acceptor<Protocol1, Executor1>&& other,
- typename constraint<
- is_convertible<Protocol1, Protocol>::value
- && is_convertible<Executor1, Executor>::value
- >::type = 0)
- : impl_(std::move(other.impl_))
- {
- }
- /// Move-assign a basic_socket_acceptor from an acceptor of another protocol
- /// type.
- /**
- * This assignment operator moves an acceptor from one object to another.
- *
- * @param other The other basic_socket_acceptor object from which the move
- * will occur.
- *
- * @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket_acceptor(const executor_type&)
- * constructor.
- */
- template <typename Protocol1, typename Executor1>
- typename constraint<
- is_convertible<Protocol1, Protocol>::value
- && is_convertible<Executor1, Executor>::value,
- basic_socket_acceptor&
- >::type operator=(basic_socket_acceptor<Protocol1, Executor1>&& other)
- {
- basic_socket_acceptor tmp(std::move(other));
- impl_ = std::move(tmp.impl_);
- return *this;
- }
- #endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Destroys the acceptor.
- /**
- * This function destroys the acceptor, cancelling any outstanding
- * asynchronous operations associated with the acceptor as if by calling
- * @c cancel.
- */
- ~basic_socket_acceptor()
- {
- }
- /// Get the executor associated with the object.
- executor_type get_executor() BOOST_ASIO_NOEXCEPT
- {
- return impl_.get_executor();
- }
- /// Open the acceptor using the specified protocol.
- /**
- * This function opens the socket acceptor so that it will use the specified
- * protocol.
- *
- * @param protocol An object specifying which protocol is to be used.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * acceptor.open(boost::asio::ip::tcp::v4());
- * @endcode
- */
- void open(const protocol_type& protocol = protocol_type())
- {
- boost::system::error_code ec;
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- boost::asio::detail::throw_error(ec, "open");
- }
- /// Open the acceptor using the specified protocol.
- /**
- * This function opens the socket acceptor so that it will use the specified
- * protocol.
- *
- * @param protocol An object specifying which protocol is to be used.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * boost::system::error_code ec;
- * acceptor.open(boost::asio::ip::tcp::v4(), ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- BOOST_ASIO_SYNC_OP_VOID open(const protocol_type& protocol,
- boost::system::error_code& ec)
- {
- impl_.get_service().open(impl_.get_implementation(), protocol, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Assigns an existing native acceptor to the acceptor.
- /*
- * This function opens the acceptor to hold an existing native acceptor.
- *
- * @param protocol An object specifying which protocol is to be used.
- *
- * @param native_acceptor A native acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- void assign(const protocol_type& protocol,
- const native_handle_type& native_acceptor)
- {
- boost::system::error_code ec;
- impl_.get_service().assign(impl_.get_implementation(),
- protocol, native_acceptor, ec);
- boost::asio::detail::throw_error(ec, "assign");
- }
- /// Assigns an existing native acceptor to the acceptor.
- /*
- * This function opens the acceptor to hold an existing native acceptor.
- *
- * @param protocol An object specifying which protocol is to be used.
- *
- * @param native_acceptor A native acceptor.
- *
- * @param ec Set to indicate what error occurred, if any.
- */
- BOOST_ASIO_SYNC_OP_VOID assign(const protocol_type& protocol,
- const native_handle_type& native_acceptor, boost::system::error_code& ec)
- {
- impl_.get_service().assign(impl_.get_implementation(),
- protocol, native_acceptor, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Determine whether the acceptor is open.
- bool is_open() const
- {
- return impl_.get_service().is_open(impl_.get_implementation());
- }
- /// Bind the acceptor to the given local endpoint.
- /**
- * This function binds the socket acceptor to the specified endpoint on the
- * local machine.
- *
- * @param endpoint An endpoint on the local machine to which the socket
- * acceptor will be bound.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), 12345);
- * acceptor.open(endpoint.protocol());
- * acceptor.bind(endpoint);
- * @endcode
- */
- void bind(const endpoint_type& endpoint)
- {
- boost::system::error_code ec;
- impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
- boost::asio::detail::throw_error(ec, "bind");
- }
- /// Bind the acceptor to the given local endpoint.
- /**
- * This function binds the socket acceptor to the specified endpoint on the
- * local machine.
- *
- * @param endpoint An endpoint on the local machine to which the socket
- * acceptor will be bound.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), 12345);
- * acceptor.open(endpoint.protocol());
- * boost::system::error_code ec;
- * acceptor.bind(endpoint, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- BOOST_ASIO_SYNC_OP_VOID bind(const endpoint_type& endpoint,
- boost::system::error_code& ec)
- {
- impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Place the acceptor into the state where it will listen for new
- /// connections.
- /**
- * This function puts the socket acceptor into the state where it may accept
- * new connections.
- *
- * @param backlog The maximum length of the queue of pending connections.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- void listen(int backlog = socket_base::max_listen_connections)
- {
- boost::system::error_code ec;
- impl_.get_service().listen(impl_.get_implementation(), backlog, ec);
- boost::asio::detail::throw_error(ec, "listen");
- }
- /// Place the acceptor into the state where it will listen for new
- /// connections.
- /**
- * This function puts the socket acceptor into the state where it may accept
- * new connections.
- *
- * @param backlog The maximum length of the queue of pending connections.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::system::error_code ec;
- * acceptor.listen(boost::asio::socket_base::max_listen_connections, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- BOOST_ASIO_SYNC_OP_VOID listen(int backlog, boost::system::error_code& ec)
- {
- impl_.get_service().listen(impl_.get_implementation(), backlog, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Close the acceptor.
- /**
- * This function is used to close the acceptor. Any asynchronous accept
- * operations will be cancelled immediately.
- *
- * A subsequent call to open() is required before the acceptor can again be
- * used to again perform socket accept operations.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- void close()
- {
- boost::system::error_code ec;
- impl_.get_service().close(impl_.get_implementation(), ec);
- boost::asio::detail::throw_error(ec, "close");
- }
- /// Close the acceptor.
- /**
- * This function is used to close the acceptor. Any asynchronous accept
- * operations will be cancelled immediately.
- *
- * A subsequent call to open() is required before the acceptor can again be
- * used to again perform socket accept operations.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::system::error_code ec;
- * acceptor.close(ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- BOOST_ASIO_SYNC_OP_VOID close(boost::system::error_code& ec)
- {
- impl_.get_service().close(impl_.get_implementation(), ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Release ownership of the underlying native acceptor.
- /**
- * This function causes all outstanding asynchronous accept operations to
- * finish immediately, and the handlers for cancelled operations will be
- * passed the boost::asio::error::operation_aborted error. Ownership of the
- * native acceptor is then transferred to the caller.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note This function is unsupported on Windows versions prior to Windows
- * 8.1, and will fail with boost::asio::error::operation_not_supported on
- * these platforms.
- */
- #if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1400) \
- && (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
- __declspec(deprecated("This function always fails with "
- "operation_not_supported when used on Windows versions "
- "prior to Windows 8.1."))
- #endif
- native_handle_type release()
- {
- boost::system::error_code ec;
- native_handle_type s = impl_.get_service().release(
- impl_.get_implementation(), ec);
- boost::asio::detail::throw_error(ec, "release");
- return s;
- }
- /// Release ownership of the underlying native acceptor.
- /**
- * This function causes all outstanding asynchronous accept operations to
- * finish immediately, and the handlers for cancelled operations will be
- * passed the boost::asio::error::operation_aborted error. Ownership of the
- * native acceptor is then transferred to the caller.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note This function is unsupported on Windows versions prior to Windows
- * 8.1, and will fail with boost::asio::error::operation_not_supported on
- * these platforms.
- */
- #if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1400) \
- && (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
- __declspec(deprecated("This function always fails with "
- "operation_not_supported when used on Windows versions "
- "prior to Windows 8.1."))
- #endif
- native_handle_type release(boost::system::error_code& ec)
- {
- return impl_.get_service().release(impl_.get_implementation(), ec);
- }
- /// Get the native acceptor representation.
- /**
- * This function may be used to obtain the underlying representation of the
- * acceptor. This is intended to allow access to native acceptor functionality
- * that is not otherwise provided.
- */
- native_handle_type native_handle()
- {
- return impl_.get_service().native_handle(impl_.get_implementation());
- }
- /// Cancel all asynchronous operations associated with the acceptor.
- /**
- * This function causes all outstanding asynchronous connect, send and receive
- * operations to finish immediately, and the handlers for cancelled operations
- * will be passed the boost::asio::error::operation_aborted error.
- *
- * @throws boost::system::system_error Thrown on failure.
- */
- void cancel()
- {
- boost::system::error_code ec;
- impl_.get_service().cancel(impl_.get_implementation(), ec);
- boost::asio::detail::throw_error(ec, "cancel");
- }
- /// Cancel all asynchronous operations associated with the acceptor.
- /**
- * This function causes all outstanding asynchronous connect, send and receive
- * operations to finish immediately, and the handlers for cancelled operations
- * will be passed the boost::asio::error::operation_aborted error.
- *
- * @param ec Set to indicate what error occurred, if any.
- */
- BOOST_ASIO_SYNC_OP_VOID cancel(boost::system::error_code& ec)
- {
- impl_.get_service().cancel(impl_.get_implementation(), ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Set an option on the acceptor.
- /**
- * This function is used to set an option on the acceptor.
- *
- * @param option The new option value to be set on the acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @sa SettableSocketOption @n
- * boost::asio::socket_base::reuse_address
- * boost::asio::socket_base::enable_connection_aborted
- *
- * @par Example
- * Setting the SOL_SOCKET/SO_REUSEADDR option:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::reuse_address option(true);
- * acceptor.set_option(option);
- * @endcode
- */
- template <typename SettableSocketOption>
- void set_option(const SettableSocketOption& option)
- {
- boost::system::error_code ec;
- impl_.get_service().set_option(impl_.get_implementation(), option, ec);
- boost::asio::detail::throw_error(ec, "set_option");
- }
- /// Set an option on the acceptor.
- /**
- * This function is used to set an option on the acceptor.
- *
- * @param option The new option value to be set on the acceptor.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @sa SettableSocketOption @n
- * boost::asio::socket_base::reuse_address
- * boost::asio::socket_base::enable_connection_aborted
- *
- * @par Example
- * Setting the SOL_SOCKET/SO_REUSEADDR option:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::reuse_address option(true);
- * boost::system::error_code ec;
- * acceptor.set_option(option, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename SettableSocketOption>
- BOOST_ASIO_SYNC_OP_VOID set_option(const SettableSocketOption& option,
- boost::system::error_code& ec)
- {
- impl_.get_service().set_option(impl_.get_implementation(), option, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Get an option from the acceptor.
- /**
- * This function is used to get the current value of an option on the
- * acceptor.
- *
- * @param option The option value to be obtained from the acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @sa GettableSocketOption @n
- * boost::asio::socket_base::reuse_address
- *
- * @par Example
- * Getting the value of the SOL_SOCKET/SO_REUSEADDR option:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::reuse_address option;
- * acceptor.get_option(option);
- * bool is_set = option.get();
- * @endcode
- */
- template <typename GettableSocketOption>
- void get_option(GettableSocketOption& option) const
- {
- boost::system::error_code ec;
- impl_.get_service().get_option(impl_.get_implementation(), option, ec);
- boost::asio::detail::throw_error(ec, "get_option");
- }
- /// Get an option from the acceptor.
- /**
- * This function is used to get the current value of an option on the
- * acceptor.
- *
- * @param option The option value to be obtained from the acceptor.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @sa GettableSocketOption @n
- * boost::asio::socket_base::reuse_address
- *
- * @par Example
- * Getting the value of the SOL_SOCKET/SO_REUSEADDR option:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::reuse_address option;
- * boost::system::error_code ec;
- * acceptor.get_option(option, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * bool is_set = option.get();
- * @endcode
- */
- template <typename GettableSocketOption>
- BOOST_ASIO_SYNC_OP_VOID get_option(GettableSocketOption& option,
- boost::system::error_code& ec) const
- {
- impl_.get_service().get_option(impl_.get_implementation(), option, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Perform an IO control command on the acceptor.
- /**
- * This function is used to execute an IO control command on the acceptor.
- *
- * @param command The IO control command to be performed on the acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @sa IoControlCommand @n
- * boost::asio::socket_base::non_blocking_io
- *
- * @par Example
- * Getting the number of bytes ready to read:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::non_blocking_io command(true);
- * socket.io_control(command);
- * @endcode
- */
- template <typename IoControlCommand>
- void io_control(IoControlCommand& command)
- {
- boost::system::error_code ec;
- impl_.get_service().io_control(impl_.get_implementation(), command, ec);
- boost::asio::detail::throw_error(ec, "io_control");
- }
- /// Perform an IO control command on the acceptor.
- /**
- * This function is used to execute an IO control command on the acceptor.
- *
- * @param command The IO control command to be performed on the acceptor.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @sa IoControlCommand @n
- * boost::asio::socket_base::non_blocking_io
- *
- * @par Example
- * Getting the number of bytes ready to read:
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::acceptor::non_blocking_io command(true);
- * boost::system::error_code ec;
- * socket.io_control(command, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename IoControlCommand>
- BOOST_ASIO_SYNC_OP_VOID io_control(IoControlCommand& command,
- boost::system::error_code& ec)
- {
- impl_.get_service().io_control(impl_.get_implementation(), command, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Gets the non-blocking mode of the acceptor.
- /**
- * @returns @c true if the acceptor's synchronous operations will fail with
- * boost::asio::error::would_block if they are unable to perform the requested
- * operation immediately. If @c false, synchronous operations will block
- * until complete.
- *
- * @note The non-blocking mode has no effect on the behaviour of asynchronous
- * operations. Asynchronous operations will never fail with the error
- * boost::asio::error::would_block.
- */
- bool non_blocking() const
- {
- return impl_.get_service().non_blocking(impl_.get_implementation());
- }
- /// Sets the non-blocking mode of the acceptor.
- /**
- * @param mode If @c true, the acceptor's synchronous operations will fail
- * with boost::asio::error::would_block if they are unable to perform the
- * requested operation immediately. If @c false, synchronous operations will
- * block until complete.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @note The non-blocking mode has no effect on the behaviour of asynchronous
- * operations. Asynchronous operations will never fail with the error
- * boost::asio::error::would_block.
- */
- void non_blocking(bool mode)
- {
- boost::system::error_code ec;
- impl_.get_service().non_blocking(impl_.get_implementation(), mode, ec);
- boost::asio::detail::throw_error(ec, "non_blocking");
- }
- /// Sets the non-blocking mode of the acceptor.
- /**
- * @param mode If @c true, the acceptor's synchronous operations will fail
- * with boost::asio::error::would_block if they are unable to perform the
- * requested operation immediately. If @c false, synchronous operations will
- * block until complete.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @note The non-blocking mode has no effect on the behaviour of asynchronous
- * operations. Asynchronous operations will never fail with the error
- * boost::asio::error::would_block.
- */
- BOOST_ASIO_SYNC_OP_VOID non_blocking(
- bool mode, boost::system::error_code& ec)
- {
- impl_.get_service().non_blocking(impl_.get_implementation(), mode, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Gets the non-blocking mode of the native acceptor implementation.
- /**
- * This function is used to retrieve the non-blocking mode of the underlying
- * native acceptor. This mode has no effect on the behaviour of the acceptor
- * object's synchronous operations.
- *
- * @returns @c true if the underlying acceptor is in non-blocking mode and
- * direct system calls may fail with boost::asio::error::would_block (or the
- * equivalent system error).
- *
- * @note The current non-blocking mode is cached by the acceptor object.
- * Consequently, the return value may be incorrect if the non-blocking mode
- * was set directly on the native acceptor.
- */
- bool native_non_blocking() const
- {
- return impl_.get_service().native_non_blocking(impl_.get_implementation());
- }
- /// Sets the non-blocking mode of the native acceptor implementation.
- /**
- * This function is used to modify the non-blocking mode of the underlying
- * native acceptor. It has no effect on the behaviour of the acceptor object's
- * synchronous operations.
- *
- * @param mode If @c true, the underlying acceptor is put into non-blocking
- * mode and direct system calls may fail with boost::asio::error::would_block
- * (or the equivalent system error).
- *
- * @throws boost::system::system_error Thrown on failure. If the @c mode is
- * @c false, but the current value of @c non_blocking() is @c true, this
- * function fails with boost::asio::error::invalid_argument, as the
- * combination does not make sense.
- */
- void native_non_blocking(bool mode)
- {
- boost::system::error_code ec;
- impl_.get_service().native_non_blocking(
- impl_.get_implementation(), mode, ec);
- boost::asio::detail::throw_error(ec, "native_non_blocking");
- }
- /// Sets the non-blocking mode of the native acceptor implementation.
- /**
- * This function is used to modify the non-blocking mode of the underlying
- * native acceptor. It has no effect on the behaviour of the acceptor object's
- * synchronous operations.
- *
- * @param mode If @c true, the underlying acceptor is put into non-blocking
- * mode and direct system calls may fail with boost::asio::error::would_block
- * (or the equivalent system error).
- *
- * @param ec Set to indicate what error occurred, if any. If the @c mode is
- * @c false, but the current value of @c non_blocking() is @c true, this
- * function fails with boost::asio::error::invalid_argument, as the
- * combination does not make sense.
- */
- BOOST_ASIO_SYNC_OP_VOID native_non_blocking(
- bool mode, boost::system::error_code& ec)
- {
- impl_.get_service().native_non_blocking(
- impl_.get_implementation(), mode, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Get the local endpoint of the acceptor.
- /**
- * This function is used to obtain the locally bound endpoint of the acceptor.
- *
- * @returns An object that represents the local endpoint of the acceptor.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint = acceptor.local_endpoint();
- * @endcode
- */
- endpoint_type local_endpoint() const
- {
- boost::system::error_code ec;
- endpoint_type ep = impl_.get_service().local_endpoint(
- impl_.get_implementation(), ec);
- boost::asio::detail::throw_error(ec, "local_endpoint");
- return ep;
- }
- /// Get the local endpoint of the acceptor.
- /**
- * This function is used to obtain the locally bound endpoint of the acceptor.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns An object that represents the local endpoint of the acceptor.
- * Returns a default-constructed endpoint object if an error occurred and the
- * error handler did not throw an exception.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::system::error_code ec;
- * boost::asio::ip::tcp::endpoint endpoint = acceptor.local_endpoint(ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- endpoint_type local_endpoint(boost::system::error_code& ec) const
- {
- return impl_.get_service().local_endpoint(impl_.get_implementation(), ec);
- }
- /// Wait for the acceptor to become ready to read, ready to write, or to have
- /// pending error conditions.
- /**
- * This function is used to perform a blocking wait for an acceptor to enter
- * a ready to read, write or error condition state.
- *
- * @param w Specifies the desired acceptor state.
- *
- * @par Example
- * Waiting for an acceptor to become readable.
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * acceptor.wait(boost::asio::ip::tcp::acceptor::wait_read);
- * @endcode
- */
- void wait(wait_type w)
- {
- boost::system::error_code ec;
- impl_.get_service().wait(impl_.get_implementation(), w, ec);
- boost::asio::detail::throw_error(ec, "wait");
- }
- /// Wait for the acceptor to become ready to read, ready to write, or to have
- /// pending error conditions.
- /**
- * This function is used to perform a blocking wait for an acceptor to enter
- * a ready to read, write or error condition state.
- *
- * @param w Specifies the desired acceptor state.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * Waiting for an acceptor to become readable.
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::system::error_code ec;
- * acceptor.wait(boost::asio::ip::tcp::acceptor::wait_read, ec);
- * @endcode
- */
- BOOST_ASIO_SYNC_OP_VOID wait(wait_type w, boost::system::error_code& ec)
- {
- impl_.get_service().wait(impl_.get_implementation(), w, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Asynchronously wait for the acceptor to become ready to read, ready to
- /// write, or to have pending error conditions.
- /**
- * This function is used to perform an asynchronous wait for an acceptor to
- * enter a ready to read, write or error condition state.
- *
- * @param w Specifies the desired acceptor state.
- *
- * @param handler The handler to be called when the wait operation completes.
- * Copies will be made of the handler as required. The function signature of
- * the handler must be:
- * @code void handler(
- * const boost::system::error_code& error // Result of operation
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void wait_handler(const boost::system::error_code& error)
- * {
- * if (!error)
- * {
- * // Wait succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * acceptor.async_wait(
- * boost::asio::ip::tcp::acceptor::wait_read,
- * wait_handler);
- * @endcode
- */
- template <
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code))
- WaitHandler BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(WaitHandler,
- void (boost::system::error_code))
- async_wait(wait_type w,
- BOOST_ASIO_MOVE_ARG(WaitHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
- {
- return async_initiate<WaitHandler, void (boost::system::error_code)>(
- initiate_async_wait(this), handler, w);
- }
- #if !defined(BOOST_ASIO_NO_EXTENSIONS)
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer into the
- * given socket. The function call will block until a new connection has been
- * accepted successfully or an error occurs.
- *
- * @param peer The socket into which the new connection will be accepted.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(my_context);
- * acceptor.accept(socket);
- * @endcode
- */
- template <typename Protocol1, typename Executor1>
- void accept(basic_socket<Protocol1, Executor1>& peer,
- typename constraint<
- is_convertible<Protocol, Protocol1>::value
- >::type = 0)
- {
- boost::system::error_code ec;
- impl_.get_service().accept(impl_.get_implementation(),
- peer, static_cast<endpoint_type*>(0), ec);
- boost::asio::detail::throw_error(ec, "accept");
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer into the
- * given socket. The function call will block until a new connection has been
- * accepted successfully or an error occurs.
- *
- * @param peer The socket into which the new connection will be accepted.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(my_context);
- * boost::system::error_code ec;
- * acceptor.accept(socket, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename Protocol1, typename Executor1>
- BOOST_ASIO_SYNC_OP_VOID accept(
- basic_socket<Protocol1, Executor1>& peer, boost::system::error_code& ec,
- typename constraint<
- is_convertible<Protocol, Protocol1>::value
- >::type = 0)
- {
- impl_.get_service().accept(impl_.get_implementation(),
- peer, static_cast<endpoint_type*>(0), ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection into a
- * socket. The function call always returns immediately.
- *
- * @param peer The socket into which the new connection will be accepted.
- * Ownership of the peer object is retained by the caller, which must
- * guarantee that it is valid until the handler is called.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error // Result of operation.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(my_context);
- * acceptor.async_accept(socket, accept_handler);
- * @endcode
- */
- template <typename Protocol1, typename Executor1,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code))
- AcceptHandler BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(AcceptHandler,
- void (boost::system::error_code))
- async_accept(basic_socket<Protocol1, Executor1>& peer,
- BOOST_ASIO_MOVE_ARG(AcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type),
- typename constraint<
- is_convertible<Protocol, Protocol1>::value
- >::type = 0)
- {
- return async_initiate<AcceptHandler, void (boost::system::error_code)>(
- initiate_async_accept(this), handler,
- &peer, static_cast<endpoint_type*>(0));
- }
- /// Accept a new connection and obtain the endpoint of the peer
- /**
- * This function is used to accept a new connection from a peer into the
- * given socket, and additionally provide the endpoint of the remote peer.
- * The function call will block until a new connection has been accepted
- * successfully or an error occurs.
- *
- * @param peer The socket into which the new connection will be accepted.
- *
- * @param peer_endpoint An endpoint object which will receive the endpoint of
- * the remote peer.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(my_context);
- * boost::asio::ip::tcp::endpoint endpoint;
- * acceptor.accept(socket, endpoint);
- * @endcode
- */
- template <typename Executor1>
- void accept(basic_socket<protocol_type, Executor1>& peer,
- endpoint_type& peer_endpoint)
- {
- boost::system::error_code ec;
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- boost::asio::detail::throw_error(ec, "accept");
- }
- /// Accept a new connection and obtain the endpoint of the peer
- /**
- * This function is used to accept a new connection from a peer into the
- * given socket, and additionally provide the endpoint of the remote peer.
- * The function call will block until a new connection has been accepted
- * successfully or an error occurs.
- *
- * @param peer The socket into which the new connection will be accepted.
- *
- * @param peer_endpoint An endpoint object which will receive the endpoint of
- * the remote peer.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(my_context);
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::system::error_code ec;
- * acceptor.accept(socket, endpoint, ec);
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename Executor1>
- BOOST_ASIO_SYNC_OP_VOID accept(basic_socket<protocol_type, Executor1>& peer,
- endpoint_type& peer_endpoint, boost::system::error_code& ec)
- {
- impl_.get_service().accept(
- impl_.get_implementation(), peer, &peer_endpoint, ec);
- BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection into a
- * socket, and additionally obtain the endpoint of the remote peer. The
- * function call always returns immediately.
- *
- * @param peer The socket into which the new connection will be accepted.
- * Ownership of the peer object is retained by the caller, which must
- * guarantee that it is valid until the handler is called.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written. Ownership of the peer_endpoint object is
- * retained by the caller, which must guarantee that it is valid until the
- * handler is called.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error // Result of operation.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- */
- template <typename Executor1,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code))
- AcceptHandler BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(AcceptHandler,
- void (boost::system::error_code))
- async_accept(basic_socket<protocol_type, Executor1>& peer,
- endpoint_type& peer_endpoint,
- BOOST_ASIO_MOVE_ARG(AcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
- {
- return async_initiate<AcceptHandler, void (boost::system::error_code)>(
- initiate_async_accept(this), handler, &peer, &peer_endpoint);
- }
- #endif // !defined(BOOST_ASIO_NO_EXTENSIONS)
- #if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept());
- * @endcode
- */
- typename Protocol::socket::template rebind_executor<executor_type>::other
- accept()
- {
- boost::system::error_code ec;
- typename Protocol::socket::template rebind_executor<
- executor_type>::other peer(impl_.get_executor());
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept(ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- typename Protocol::socket::template rebind_executor<executor_type>::other
- accept(boost::system::error_code& ec)
- {
- typename Protocol::socket::template rebind_executor<
- executor_type>::other peer(impl_.get_executor());
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- return peer;
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * // Result of operation.
- * const boost::system::error_code& error,
- * // On success, the newly accepted socket.
- * typename Protocol::socket::template
- * rebind_executor<executor_type>::other peer
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * acceptor.async_accept(accept_handler);
- * @endcode
- */
- template <
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- executor_type>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template
- rebind_executor<executor_type>::other))
- async_accept(
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
- {
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, typename Protocol::socket::template
- rebind_executor<executor_type>::other)>(
- initiate_async_move_accept(this), handler,
- impl_.get_executor(), static_cast<endpoint_type*>(0),
- static_cast<typename Protocol::socket::template
- rebind_executor<executor_type>::other*>(0));
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly
- * accepted socket.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept());
- * @endcode
- */
- template <typename Executor1>
- typename Protocol::socket::template rebind_executor<Executor1>::other
- accept(const Executor1& ex,
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- boost::system::error_code ec;
- typename Protocol::socket::template
- rebind_executor<Executor1>::other peer(ex);
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept());
- * @endcode
- */
- template <typename ExecutionContext>
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other
- accept(ExecutionContext& context,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- boost::system::error_code ec;
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other peer(context);
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly accepted
- * socket.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept(my_context2, ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename Executor1>
- typename Protocol::socket::template rebind_executor<Executor1>::other
- accept(const Executor1& ex, boost::system::error_code& ec,
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- typename Protocol::socket::template
- rebind_executor<Executor1>::other peer(ex);
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::socket socket(acceptor.accept(my_context2, ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename ExecutionContext>
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other
- accept(ExecutionContext& context, boost::system::error_code& ec,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other peer(context);
- impl_.get_service().accept(impl_.get_implementation(), peer, 0, ec);
- return peer;
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly accepted
- * socket.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error, // Result of operation.
- * typename Protocol::socket::template rebind_executor<
- * Executor1>::other peer // On success, the newly accepted socket.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * acceptor.async_accept(my_context2, accept_handler);
- * @endcode
- */
- template <typename Executor1,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- Executor1>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- Executor1>::other))
- async_accept(const Executor1& ex,
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type),
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- typedef typename Protocol::socket::template rebind_executor<
- Executor1>::other other_socket_type;
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, other_socket_type)>(
- initiate_async_move_accept(this), handler,
- ex, static_cast<endpoint_type*>(0),
- static_cast<other_socket_type*>(0));
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error, // Result of operation.
- * typename Protocol::socket::template rebind_executor<
- * typename ExecutionContext::executor_type>::other peer
- * // On success, the newly accepted socket.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * acceptor.async_accept(my_context2, accept_handler);
- * @endcode
- */
- template <typename ExecutionContext,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other))
- async_accept(ExecutionContext& context,
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type),
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- typedef typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other other_socket_type;
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, other_socket_type)>(
- initiate_async_move_accept(this), handler,
- context.get_executor(), static_cast<endpoint_type*>(0),
- static_cast<other_socket_type*>(0));
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(acceptor.accept(endpoint));
- * @endcode
- */
- typename Protocol::socket::template rebind_executor<executor_type>::other
- accept(endpoint_type& peer_endpoint)
- {
- boost::system::error_code ec;
- typename Protocol::socket::template rebind_executor<
- executor_type>::other peer(impl_.get_executor());
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(acceptor.accept(endpoint, ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- typename Protocol::socket::template rebind_executor<executor_type>::other
- accept(endpoint_type& peer_endpoint, boost::system::error_code& ec)
- {
- typename Protocol::socket::template rebind_executor<
- executor_type>::other peer(impl_.get_executor());
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- return peer;
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written. Ownership of the peer_endpoint object is
- * retained by the caller, which must guarantee that it is valid until the
- * handler is called.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * // Result of operation.
- * const boost::system::error_code& error,
- * // On success, the newly accepted socket.
- * typename Protocol::socket::template
- * rebind_executor<executor_type>::other peer
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * acceptor.async_accept(endpoint, accept_handler);
- * @endcode
- */
- template <
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- executor_type>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template
- rebind_executor<executor_type>::other))
- async_accept(endpoint_type& peer_endpoint,
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
- {
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, typename Protocol::socket::template
- rebind_executor<executor_type>::other)>(
- initiate_async_move_accept(this), handler,
- impl_.get_executor(), &peer_endpoint,
- static_cast<typename Protocol::socket::template
- rebind_executor<executor_type>::other*>(0));
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly accepted
- * socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(
- * acceptor.accept(my_context2, endpoint));
- * @endcode
- */
- template <typename Executor1>
- typename Protocol::socket::template rebind_executor<Executor1>::other
- accept(const Executor1& ex, endpoint_type& peer_endpoint,
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- boost::system::error_code ec;
- typename Protocol::socket::template
- rebind_executor<Executor1>::other peer(ex);
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @returns A socket object representing the newly accepted connection.
- *
- * @throws boost::system::system_error Thrown on failure.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(
- * acceptor.accept(my_context2, endpoint));
- * @endcode
- */
- template <typename ExecutionContext>
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other
- accept(ExecutionContext& context, endpoint_type& peer_endpoint,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- boost::system::error_code ec;
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other peer(context);
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- boost::asio::detail::throw_error(ec, "accept");
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly accepted
- * socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(
- * acceptor.accept(my_context2, endpoint, ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename Executor1>
- typename Protocol::socket::template rebind_executor<Executor1>::other
- accept(const executor_type& ex,
- endpoint_type& peer_endpoint, boost::system::error_code& ec,
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- typename Protocol::socket::template
- rebind_executor<Executor1>::other peer(ex);
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- return peer;
- }
- /// Accept a new connection.
- /**
- * This function is used to accept a new connection from a peer. The function
- * call will block until a new connection has been accepted successfully or
- * an error occurs.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written.
- *
- * @param ec Set to indicate what error occurred, if any.
- *
- * @returns On success, a socket object representing the newly accepted
- * connection. On error, a socket object where is_open() is false.
- *
- * @par Example
- * @code
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * boost::asio::ip::tcp::socket socket(
- * acceptor.accept(my_context2, endpoint, ec));
- * if (ec)
- * {
- * // An error occurred.
- * }
- * @endcode
- */
- template <typename ExecutionContext>
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other
- accept(ExecutionContext& context,
- endpoint_type& peer_endpoint, boost::system::error_code& ec,
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other peer(context);
- impl_.get_service().accept(impl_.get_implementation(),
- peer, &peer_endpoint, ec);
- return peer;
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param ex The I/O executor object to be used for the newly accepted
- * socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written. Ownership of the peer_endpoint object is
- * retained by the caller, which must guarantee that it is valid until the
- * handler is called.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error, // Result of operation.
- * typename Protocol::socket::template rebind_executor<
- * Executor1>::other peer // On success, the newly accepted socket.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * acceptor.async_accept(my_context2, endpoint, accept_handler);
- * @endcode
- */
- template <typename Executor1,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- Executor1>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- Executor1>::other))
- async_accept(const Executor1& ex, endpoint_type& peer_endpoint,
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type),
- typename constraint<
- is_executor<Executor1>::value
- || execution::is_executor<Executor1>::value
- >::type = 0)
- {
- typedef typename Protocol::socket::template rebind_executor<
- Executor1>::other other_socket_type;
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, other_socket_type)>(
- initiate_async_move_accept(this), handler,
- ex, &peer_endpoint,
- static_cast<other_socket_type*>(0));
- }
- /// Start an asynchronous accept.
- /**
- * This function is used to asynchronously accept a new connection. The
- * function call always returns immediately.
- *
- * This overload requires that the Protocol template parameter satisfy the
- * AcceptableProtocol type requirements.
- *
- * @param context The I/O execution context object to be used for the newly
- * accepted socket.
- *
- * @param peer_endpoint An endpoint object into which the endpoint of the
- * remote peer will be written. Ownership of the peer_endpoint object is
- * retained by the caller, which must guarantee that it is valid until the
- * handler is called.
- *
- * @param handler The handler to be called when the accept operation
- * completes. Copies will be made of the handler as required. The function
- * signature of the handler must be:
- * @code void handler(
- * const boost::system::error_code& error, // Result of operation.
- * typename Protocol::socket::template rebind_executor<
- * typename ExecutionContext::executor_type>::other peer
- * // On success, the newly accepted socket.
- * ); @endcode
- * Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. On
- * immediate completion, invocation of the handler will be performed in a
- * manner equivalent to using boost::asio::post().
- *
- * @par Example
- * @code
- * void accept_handler(const boost::system::error_code& error,
- * boost::asio::ip::tcp::socket peer)
- * {
- * if (!error)
- * {
- * // Accept succeeded.
- * }
- * }
- *
- * ...
- *
- * boost::asio::ip::tcp::acceptor acceptor(my_context);
- * ...
- * boost::asio::ip::tcp::endpoint endpoint;
- * acceptor.async_accept(my_context2, endpoint, accept_handler);
- * @endcode
- */
- template <typename ExecutionContext,
- BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other)) MoveAcceptHandler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
- BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(MoveAcceptHandler,
- void (boost::system::error_code,
- typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other))
- async_accept(ExecutionContext& context,
- endpoint_type& peer_endpoint,
- BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler
- BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type),
- typename constraint<
- is_convertible<ExecutionContext&, execution_context&>::value
- >::type = 0)
- {
- typedef typename Protocol::socket::template rebind_executor<
- typename ExecutionContext::executor_type>::other other_socket_type;
- return async_initiate<MoveAcceptHandler,
- void (boost::system::error_code, other_socket_type)>(
- initiate_async_move_accept(this), handler,
- context.get_executor(), &peer_endpoint,
- static_cast<other_socket_type*>(0));
- }
- #endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
- private:
- // Disallow copying and assignment.
- basic_socket_acceptor(const basic_socket_acceptor&) BOOST_ASIO_DELETED;
- basic_socket_acceptor& operator=(
- const basic_socket_acceptor&) BOOST_ASIO_DELETED;
- class initiate_async_wait
- {
- public:
- typedef Executor executor_type;
- explicit initiate_async_wait(basic_socket_acceptor* self)
- : self_(self)
- {
- }
- executor_type get_executor() const BOOST_ASIO_NOEXCEPT
- {
- return self_->get_executor();
- }
- template <typename WaitHandler>
- void operator()(BOOST_ASIO_MOVE_ARG(WaitHandler) handler, wait_type w) const
- {
- // If you get an error on the following line it means that your handler
- // does not meet the documented type requirements for a WaitHandler.
- BOOST_ASIO_WAIT_HANDLER_CHECK(WaitHandler, handler) type_check;
- detail::non_const_lvalue<WaitHandler> handler2(handler);
- self_->impl_.get_service().async_wait(
- self_->impl_.get_implementation(), w,
- handler2.value, self_->impl_.get_executor());
- }
- private:
- basic_socket_acceptor* self_;
- };
- class initiate_async_accept
- {
- public:
- typedef Executor executor_type;
- explicit initiate_async_accept(basic_socket_acceptor* self)
- : self_(self)
- {
- }
- executor_type get_executor() const BOOST_ASIO_NOEXCEPT
- {
- return self_->get_executor();
- }
- template <typename AcceptHandler, typename Protocol1, typename Executor1>
- void operator()(BOOST_ASIO_MOVE_ARG(AcceptHandler) handler,
- basic_socket<Protocol1, Executor1>* peer,
- endpoint_type* peer_endpoint) const
- {
- // If you get an error on the following line it means that your handler
- // does not meet the documented type requirements for a AcceptHandler.
- BOOST_ASIO_ACCEPT_HANDLER_CHECK(AcceptHandler, handler) type_check;
- detail::non_const_lvalue<AcceptHandler> handler2(handler);
- self_->impl_.get_service().async_accept(
- self_->impl_.get_implementation(), *peer, peer_endpoint,
- handler2.value, self_->impl_.get_executor());
- }
- private:
- basic_socket_acceptor* self_;
- };
- class initiate_async_move_accept
- {
- public:
- typedef Executor executor_type;
- explicit initiate_async_move_accept(basic_socket_acceptor* self)
- : self_(self)
- {
- }
- executor_type get_executor() const BOOST_ASIO_NOEXCEPT
- {
- return self_->get_executor();
- }
- template <typename MoveAcceptHandler, typename Executor1, typename Socket>
- void operator()(BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler,
- const Executor1& peer_ex, endpoint_type* peer_endpoint, Socket*) const
- {
- // If you get an error on the following line it means that your handler
- // does not meet the documented type requirements for a MoveAcceptHandler.
- BOOST_ASIO_MOVE_ACCEPT_HANDLER_CHECK(
- MoveAcceptHandler, handler, Socket) type_check;
- detail::non_const_lvalue<MoveAcceptHandler> handler2(handler);
- self_->impl_.get_service().async_move_accept(
- self_->impl_.get_implementation(), peer_ex, peer_endpoint,
- handler2.value, self_->impl_.get_executor());
- }
- private:
- basic_socket_acceptor* self_;
- };
- #if defined(BOOST_ASIO_WINDOWS_RUNTIME)
- detail::io_object_impl<
- detail::null_socket_service<Protocol>, Executor> impl_;
- #elif defined(BOOST_ASIO_HAS_IOCP)
- detail::io_object_impl<
- detail::win_iocp_socket_service<Protocol>, Executor> impl_;
- #else
- detail::io_object_impl<
- detail::reactive_socket_service<Protocol>, Executor> impl_;
- #endif
- };
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #endif // BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_HPP
|