|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r76516 - in branches/release: boost boost/asio boost/asio/detail boost/asio/detail/impl boost/asio/impl boost/asio/ip boost/asio/ip/detail boost/asio/ip/detail/impl boost/asio/ip/impl boost/asio/local boost/asio/local/detail boost/asio/local/detail/impl boost/asio/posix boost/asio/ssl boost/asio/ssl/detail boost/asio/ssl/detail/impl boost/asio/ssl/impl boost/asio/ssl/old boost/asio/ssl/old/detail boost/asio/windows libs/asio/doc libs/asio/doc/overview libs/asio/doc/requirements libs/asio/example/allocation libs/asio/example/buffers libs/asio/example/chat libs/asio/example/echo libs/asio/example/fork libs/asio/example/http/client libs/asio/example/http/doc_root libs/asio/example/http/server libs/asio/example/http/server2 libs/asio/example/http/server3 libs/asio/example/http/server4 libs/asio/example/icmp libs/asio/example/invocation libs/asio/example/iostreams libs/asio/example/local libs/asio/example/multicast libs/asio/example/nonblocking libs/asio/example/porthopper libs/asio/example/serialization libs/asio/example/services libs/asio/example/socks4 libs/asio/example/ssl libs/asio/example/timeouts libs/asio/example/timers libs/asio/example/tutorial libs/asio/example/tutorial/daytime1 libs/asio/example/tutorial/daytime2 libs/asio/example/tutorial/daytime3 libs/asio/example/tutorial/daytime4 libs/asio/example/tutorial/daytime5 libs/asio/example/tutorial/daytime6 libs/asio/example/tutorial/daytime7 libs/asio/example/tutorial/timer1 libs/asio/example/tutorial/timer2 libs/asio/example/tutorial/timer3 libs/asio/example/tutorial/timer4 libs/asio/example/tutorial/timer5 libs/asio/example/windows libs/asio/test libs/asio/test/archetypes libs/asio/test/ip libs/asio/test/latency libs/asio/test/local libs/asio/test/posix libs/asio/test/ssl libs/asio/test/windows
From: chris_at_[hidden]
Date: 2012-01-15 08:47:34
Author: chris_kohlhoff
Date: 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
New Revision: 76516
URL: http://svn.boost.org/trac/boost/changeset/76516
Log:
Merge from trunk:
* Chrono support.
* Added object_handle support.
* Need to enable the basic_handle class when object_handle is supported.
* Update copyright notices.
* Fix MSVC "performance warning".
* Fix for NetBSD. Fixes #6098.
* Fix regression in buffered_write_stream. Fixes #6310.
* Fix deadlock on Mac OS X. Fixes #6275.
* On linux, connect can return EAGAIN in certain circumstances. Remap to another
error so that it doesn't look like a non-blocking operation. Fixes #6048.
* Fix non-paged pool "leak" on Windows when io_service is repeatedly run without anything to do. Fixes #6321.
* Disable object_handle on Windows CE.
* Add extra include required for OVERLAPPED struct.
* Fix doxygen comments.
* Update documentation.
* Add missing class.
* Update copyright year.
Added:
branches/release/boost/asio/basic_waitable_timer.hpp (contents, props changed)
branches/release/boost/asio/detail/chrono_time_traits.hpp (contents, props changed)
branches/release/boost/asio/detail/date_time_fwd.hpp (contents, props changed)
branches/release/boost/asio/detail/impl/timer_queue_ptime.ipp (contents, props changed)
branches/release/boost/asio/detail/impl/win_object_handle_service.ipp (contents, props changed)
branches/release/boost/asio/detail/timer_queue_ptime.hpp (contents, props changed)
branches/release/boost/asio/detail/wait_op.hpp (contents, props changed)
branches/release/boost/asio/detail/win_object_handle_service.hpp (contents, props changed)
branches/release/boost/asio/high_resolution_timer.hpp (contents, props changed)
branches/release/boost/asio/steady_timer.hpp (contents, props changed)
branches/release/boost/asio/system_timer.hpp (contents, props changed)
branches/release/boost/asio/wait_traits.hpp (contents, props changed)
branches/release/boost/asio/waitable_timer_service.hpp (contents, props changed)
branches/release/boost/asio/windows/basic_object_handle.hpp (contents, props changed)
branches/release/boost/asio/windows/object_handle.hpp (contents, props changed)
branches/release/boost/asio/windows/object_handle_service.hpp (contents, props changed)
branches/release/libs/asio/doc/requirements/ObjectHandleService.qbk (contents, props changed)
branches/release/libs/asio/doc/requirements/WaitTraits.qbk (contents, props changed)
branches/release/libs/asio/doc/requirements/WaitableTimerService.qbk (contents, props changed)
branches/release/libs/asio/test/basic_waitable_timer.cpp (contents, props changed)
branches/release/libs/asio/test/high_resolution_timer.cpp (contents, props changed)
branches/release/libs/asio/test/steady_timer.cpp (contents, props changed)
branches/release/libs/asio/test/system_timer.cpp (contents, props changed)
branches/release/libs/asio/test/wait_traits.cpp (contents, props changed)
branches/release/libs/asio/test/waitable_timer_service.cpp (contents, props changed)
branches/release/libs/asio/test/windows/basic_object_handle.cpp (contents, props changed)
branches/release/libs/asio/test/windows/object_handle.cpp (contents, props changed)
branches/release/libs/asio/test/windows/object_handle_service.cpp (contents, props changed)
Removed:
branches/release/boost/asio/detail/timer_op.hpp
Text files modified:
branches/release/boost/asio.hpp | 8
branches/release/boost/asio/basic_datagram_socket.hpp | 2
branches/release/boost/asio/basic_deadline_timer.hpp | 2
branches/release/boost/asio/basic_io_object.hpp | 2
branches/release/boost/asio/basic_raw_socket.hpp | 2
branches/release/boost/asio/basic_seq_packet_socket.hpp | 2
branches/release/boost/asio/basic_serial_port.hpp | 2
branches/release/boost/asio/basic_signal_set.hpp | 2
branches/release/boost/asio/basic_socket.hpp | 2
branches/release/boost/asio/basic_socket_acceptor.hpp | 2
branches/release/boost/asio/basic_socket_iostream.hpp | 2
branches/release/boost/asio/basic_socket_streambuf.hpp | 2
branches/release/boost/asio/basic_stream_socket.hpp | 2
branches/release/boost/asio/basic_streambuf.hpp | 2
branches/release/boost/asio/basic_streambuf_fwd.hpp | 2
branches/release/boost/asio/buffer.hpp | 2
branches/release/boost/asio/buffered_read_stream.hpp | 2
branches/release/boost/asio/buffered_read_stream_fwd.hpp | 2
branches/release/boost/asio/buffered_stream.hpp | 2
branches/release/boost/asio/buffered_stream_fwd.hpp | 2
branches/release/boost/asio/buffered_write_stream.hpp | 5
branches/release/boost/asio/buffered_write_stream_fwd.hpp | 2
branches/release/boost/asio/buffers_iterator.hpp | 2
branches/release/boost/asio/completion_condition.hpp | 2
branches/release/boost/asio/connect.hpp | 2
branches/release/boost/asio/datagram_socket_service.hpp | 2
branches/release/boost/asio/deadline_timer.hpp | 2
branches/release/boost/asio/deadline_timer_service.hpp | 3
branches/release/boost/asio/detail/array.hpp | 2
branches/release/boost/asio/detail/array_fwd.hpp | 2
branches/release/boost/asio/detail/atomic_count.hpp | 2
branches/release/boost/asio/detail/base_from_completion_cond.hpp | 2
branches/release/boost/asio/detail/bind_handler.hpp | 2
branches/release/boost/asio/detail/buffer_resize_guard.hpp | 2
branches/release/boost/asio/detail/buffer_sequence_adapter.hpp | 2
branches/release/boost/asio/detail/buffered_stream_storage.hpp | 2
branches/release/boost/asio/detail/call_stack.hpp | 2
branches/release/boost/asio/detail/completion_handler.hpp | 2
branches/release/boost/asio/detail/config.hpp | 33
branches/release/boost/asio/detail/consuming_buffers.hpp | 2
branches/release/boost/asio/detail/deadline_timer_service.hpp | 28
branches/release/boost/asio/detail/dependent_type.hpp | 2
branches/release/boost/asio/detail/descriptor_ops.hpp | 2
branches/release/boost/asio/detail/descriptor_read_op.hpp | 2
branches/release/boost/asio/detail/descriptor_write_op.hpp | 2
branches/release/boost/asio/detail/dev_poll_reactor.hpp | 6
branches/release/boost/asio/detail/dev_poll_reactor_fwd.hpp | 2
branches/release/boost/asio/detail/epoll_reactor.hpp | 6
branches/release/boost/asio/detail/epoll_reactor_fwd.hpp | 2
branches/release/boost/asio/detail/event.hpp | 2
branches/release/boost/asio/detail/eventfd_select_interrupter.hpp | 2
branches/release/boost/asio/detail/fd_set_adapter.hpp | 2
branches/release/boost/asio/detail/fenced_block.hpp | 2
branches/release/boost/asio/detail/gcc_arm_fenced_block.hpp | 2
branches/release/boost/asio/detail/gcc_hppa_fenced_block.hpp | 2
branches/release/boost/asio/detail/gcc_sync_fenced_block.hpp | 2
branches/release/boost/asio/detail/gcc_x86_fenced_block.hpp | 2
branches/release/boost/asio/detail/handler_alloc_helpers.hpp | 2
branches/release/boost/asio/detail/handler_invoke_helpers.hpp | 2
branches/release/boost/asio/detail/handler_tracking.hpp | 2
branches/release/boost/asio/detail/handler_type_requirements.hpp | 2
branches/release/boost/asio/detail/hash_map.hpp | 2
branches/release/boost/asio/detail/impl/descriptor_ops.ipp | 2
branches/release/boost/asio/detail/impl/dev_poll_reactor.hpp | 4
branches/release/boost/asio/detail/impl/dev_poll_reactor.ipp | 2
branches/release/boost/asio/detail/impl/epoll_reactor.hpp | 4
branches/release/boost/asio/detail/impl/epoll_reactor.ipp | 2
branches/release/boost/asio/detail/impl/eventfd_select_interrupter.ipp | 2
branches/release/boost/asio/detail/impl/handler_tracking.ipp | 2
branches/release/boost/asio/detail/impl/kqueue_reactor.hpp | 4
branches/release/boost/asio/detail/impl/kqueue_reactor.ipp | 6
branches/release/boost/asio/detail/impl/pipe_select_interrupter.ipp | 2
branches/release/boost/asio/detail/impl/posix_event.ipp | 2
branches/release/boost/asio/detail/impl/posix_mutex.ipp | 2
branches/release/boost/asio/detail/impl/posix_thread.ipp | 2
branches/release/boost/asio/detail/impl/posix_tss_ptr.ipp | 2
branches/release/boost/asio/detail/impl/reactive_descriptor_service.ipp | 2
branches/release/boost/asio/detail/impl/reactive_serial_port_service.ipp | 2
branches/release/boost/asio/detail/impl/reactive_socket_service_base.ipp | 2
branches/release/boost/asio/detail/impl/resolver_service_base.ipp | 2
branches/release/boost/asio/detail/impl/select_reactor.hpp | 4
branches/release/boost/asio/detail/impl/select_reactor.ipp | 2
branches/release/boost/asio/detail/impl/service_registry.hpp | 2
branches/release/boost/asio/detail/impl/service_registry.ipp | 2
branches/release/boost/asio/detail/impl/signal_set_service.ipp | 2
branches/release/boost/asio/detail/impl/socket_ops.ipp | 6
branches/release/boost/asio/detail/impl/socket_select_interrupter.ipp | 2
branches/release/boost/asio/detail/impl/strand_service.hpp | 2
branches/release/boost/asio/detail/impl/strand_service.ipp | 2
branches/release/boost/asio/detail/impl/task_io_service.hpp | 2
branches/release/boost/asio/detail/impl/task_io_service.ipp | 7
branches/release/boost/asio/detail/impl/throw_error.ipp | 2
branches/release/boost/asio/detail/impl/timer_queue_set.ipp | 2
branches/release/boost/asio/detail/impl/win_event.ipp | 2
branches/release/boost/asio/detail/impl/win_iocp_handle_service.ipp | 2
branches/release/boost/asio/detail/impl/win_iocp_io_service.hpp | 4
branches/release/boost/asio/detail/impl/win_iocp_io_service.ipp | 10
branches/release/boost/asio/detail/impl/win_iocp_serial_port_service.ipp | 2
branches/release/boost/asio/detail/impl/win_iocp_socket_service_base.ipp | 2
branches/release/boost/asio/detail/impl/win_mutex.ipp | 2
branches/release/boost/asio/detail/impl/win_static_mutex.ipp | 2
branches/release/boost/asio/detail/impl/win_thread.ipp | 2
branches/release/boost/asio/detail/impl/win_tss_ptr.ipp | 2
branches/release/boost/asio/detail/impl/winsock_init.ipp | 2
branches/release/boost/asio/detail/io_control.hpp | 2
branches/release/boost/asio/detail/kqueue_reactor.hpp | 6
branches/release/boost/asio/detail/kqueue_reactor_fwd.hpp | 2
branches/release/boost/asio/detail/local_free_on_block_exit.hpp | 2
branches/release/boost/asio/detail/macos_fenced_block.hpp | 2
branches/release/boost/asio/detail/mutex.hpp | 2
branches/release/boost/asio/detail/noncopyable.hpp | 2
branches/release/boost/asio/detail/null_event.hpp | 2
branches/release/boost/asio/detail/null_fenced_block.hpp | 2
branches/release/boost/asio/detail/null_mutex.hpp | 2
branches/release/boost/asio/detail/null_signal_blocker.hpp | 2
branches/release/boost/asio/detail/null_static_mutex.hpp | 2
branches/release/boost/asio/detail/null_thread.hpp | 2
branches/release/boost/asio/detail/null_tss_ptr.hpp | 2
branches/release/boost/asio/detail/object_pool.hpp | 2
branches/release/boost/asio/detail/old_win_sdk_compat.hpp | 2
branches/release/boost/asio/detail/op_queue.hpp | 2
branches/release/boost/asio/detail/operation.hpp | 2
branches/release/boost/asio/detail/pipe_select_interrupter.hpp | 2
branches/release/boost/asio/detail/pop_options.hpp | 2
branches/release/boost/asio/detail/posix_event.hpp | 2
branches/release/boost/asio/detail/posix_fd_set_adapter.hpp | 2
branches/release/boost/asio/detail/posix_mutex.hpp | 2
branches/release/boost/asio/detail/posix_signal_blocker.hpp | 2
branches/release/boost/asio/detail/posix_static_mutex.hpp | 2
branches/release/boost/asio/detail/posix_thread.hpp | 2
branches/release/boost/asio/detail/posix_tss_ptr.hpp | 2
branches/release/boost/asio/detail/push_options.hpp | 2
branches/release/boost/asio/detail/reactive_descriptor_service.hpp | 2
branches/release/boost/asio/detail/reactive_null_buffers_op.hpp | 2
branches/release/boost/asio/detail/reactive_serial_port_service.hpp | 2
branches/release/boost/asio/detail/reactive_socket_accept_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_connect_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_recv_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_recvfrom_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_recvmsg_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_send_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_sendto_op.hpp | 2
branches/release/boost/asio/detail/reactive_socket_service.hpp | 2
branches/release/boost/asio/detail/reactive_socket_service_base.hpp | 2
branches/release/boost/asio/detail/reactor.hpp | 2
branches/release/boost/asio/detail/reactor_fwd.hpp | 2
branches/release/boost/asio/detail/reactor_op.hpp | 2
branches/release/boost/asio/detail/reactor_op_queue.hpp | 2
branches/release/boost/asio/detail/regex_fwd.hpp | 2
branches/release/boost/asio/detail/resolve_endpoint_op.hpp | 2
branches/release/boost/asio/detail/resolve_op.hpp | 2
branches/release/boost/asio/detail/resolver_service.hpp | 2
branches/release/boost/asio/detail/resolver_service_base.hpp | 2
branches/release/boost/asio/detail/scoped_lock.hpp | 2
branches/release/boost/asio/detail/scoped_ptr.hpp | 2
branches/release/boost/asio/detail/select_interrupter.hpp | 2
branches/release/boost/asio/detail/select_reactor.hpp | 6
branches/release/boost/asio/detail/select_reactor_fwd.hpp | 2
branches/release/boost/asio/detail/service_registry.hpp | 2
branches/release/boost/asio/detail/service_registry_fwd.hpp | 2
branches/release/boost/asio/detail/shared_ptr.hpp | 2
branches/release/boost/asio/detail/signal_blocker.hpp | 2
branches/release/boost/asio/detail/signal_handler.hpp | 2
branches/release/boost/asio/detail/signal_init.hpp | 2
branches/release/boost/asio/detail/signal_op.hpp | 2
branches/release/boost/asio/detail/signal_set_service.hpp | 2
branches/release/boost/asio/detail/socket_holder.hpp | 2
branches/release/boost/asio/detail/socket_ops.hpp | 2
branches/release/boost/asio/detail/socket_option.hpp | 2
branches/release/boost/asio/detail/socket_select_interrupter.hpp | 2
branches/release/boost/asio/detail/socket_types.hpp | 2
branches/release/boost/asio/detail/solaris_fenced_block.hpp | 2
branches/release/boost/asio/detail/static_mutex.hpp | 2
branches/release/boost/asio/detail/strand_service.hpp | 2
branches/release/boost/asio/detail/task_io_service.hpp | 4
branches/release/boost/asio/detail/task_io_service_fwd.hpp | 2
branches/release/boost/asio/detail/task_io_service_operation.hpp | 2
branches/release/boost/asio/detail/thread.hpp | 2
branches/release/boost/asio/detail/throw_error.hpp | 2
branches/release/boost/asio/detail/timer_queue.hpp | 141
branches/release/boost/asio/detail/timer_queue_base.hpp | 2
branches/release/boost/asio/detail/timer_queue_fwd.hpp | 2
branches/release/boost/asio/detail/timer_queue_set.hpp | 2
branches/release/boost/asio/detail/timer_scheduler.hpp | 2
branches/release/boost/asio/detail/timer_scheduler_fwd.hpp | 2
branches/release/boost/asio/detail/tss_ptr.hpp | 2
branches/release/boost/asio/detail/wait_handler.hpp | 9
branches/release/boost/asio/detail/weak_ptr.hpp | 2
branches/release/boost/asio/detail/win_event.hpp | 2
branches/release/boost/asio/detail/win_fd_set_adapter.hpp | 2
branches/release/boost/asio/detail/win_fenced_block.hpp | 2
branches/release/boost/asio/detail/win_iocp_handle_read_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_handle_service.hpp | 2
branches/release/boost/asio/detail/win_iocp_handle_write_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_io_service.hpp | 10
branches/release/boost/asio/detail/win_iocp_io_service_fwd.hpp | 2
branches/release/boost/asio/detail/win_iocp_null_buffers_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_operation.hpp | 3
branches/release/boost/asio/detail/win_iocp_overlapped_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_overlapped_ptr.hpp | 2
branches/release/boost/asio/detail/win_iocp_serial_port_service.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_accept_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_recv_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_recvfrom_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_recvmsg_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_send_op.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_service.hpp | 2
branches/release/boost/asio/detail/win_iocp_socket_service_base.hpp | 2
branches/release/boost/asio/detail/win_mutex.hpp | 2
branches/release/boost/asio/detail/win_static_mutex.hpp | 2
branches/release/boost/asio/detail/win_thread.hpp | 2
branches/release/boost/asio/detail/win_tss_ptr.hpp | 2
branches/release/boost/asio/detail/wince_thread.hpp | 2
branches/release/boost/asio/detail/winsock_init.hpp | 2
branches/release/boost/asio/detail/wrapped_handler.hpp | 2
branches/release/boost/asio/error.hpp | 2
branches/release/boost/asio/handler_alloc_hook.hpp | 2
branches/release/boost/asio/handler_invoke_hook.hpp | 2
branches/release/boost/asio/impl/connect.hpp | 2
branches/release/boost/asio/impl/error.ipp | 2
branches/release/boost/asio/impl/io_service.hpp | 2
branches/release/boost/asio/impl/io_service.ipp | 2
branches/release/boost/asio/impl/read.hpp | 2
branches/release/boost/asio/impl/read_at.hpp | 2
branches/release/boost/asio/impl/read_until.hpp | 2
branches/release/boost/asio/impl/serial_port_base.hpp | 2
branches/release/boost/asio/impl/serial_port_base.ipp | 2
branches/release/boost/asio/impl/src.cpp | 2
branches/release/boost/asio/impl/src.hpp | 5
branches/release/boost/asio/impl/write.hpp | 2
branches/release/boost/asio/impl/write_at.hpp | 2
branches/release/boost/asio/io_service.hpp | 2
branches/release/boost/asio/ip/address.hpp | 2
branches/release/boost/asio/ip/address_v4.hpp | 2
branches/release/boost/asio/ip/address_v6.hpp | 2
branches/release/boost/asio/ip/basic_endpoint.hpp | 2
branches/release/boost/asio/ip/basic_resolver.hpp | 2
branches/release/boost/asio/ip/basic_resolver_entry.hpp | 2
branches/release/boost/asio/ip/basic_resolver_iterator.hpp | 2
branches/release/boost/asio/ip/basic_resolver_query.hpp | 2
branches/release/boost/asio/ip/detail/endpoint.hpp | 2
branches/release/boost/asio/ip/detail/impl/endpoint.ipp | 2
branches/release/boost/asio/ip/detail/socket_option.hpp | 2
branches/release/boost/asio/ip/host_name.hpp | 2
branches/release/boost/asio/ip/icmp.hpp | 2
branches/release/boost/asio/ip/impl/address.hpp | 2
branches/release/boost/asio/ip/impl/address.ipp | 2
branches/release/boost/asio/ip/impl/address_v4.hpp | 2
branches/release/boost/asio/ip/impl/address_v4.ipp | 2
branches/release/boost/asio/ip/impl/address_v6.hpp | 2
branches/release/boost/asio/ip/impl/address_v6.ipp | 2
branches/release/boost/asio/ip/impl/basic_endpoint.hpp | 2
branches/release/boost/asio/ip/impl/host_name.ipp | 2
branches/release/boost/asio/ip/multicast.hpp | 2
branches/release/boost/asio/ip/resolver_query_base.hpp | 2
branches/release/boost/asio/ip/resolver_service.hpp | 2
branches/release/boost/asio/ip/tcp.hpp | 2
branches/release/boost/asio/ip/udp.hpp | 2
branches/release/boost/asio/ip/unicast.hpp | 2
branches/release/boost/asio/ip/v6_only.hpp | 2
branches/release/boost/asio/is_read_buffered.hpp | 2
branches/release/boost/asio/is_write_buffered.hpp | 2
branches/release/boost/asio/local/basic_endpoint.hpp | 2
branches/release/boost/asio/local/connect_pair.hpp | 2
branches/release/boost/asio/local/datagram_protocol.hpp | 2
branches/release/boost/asio/local/detail/endpoint.hpp | 2
branches/release/boost/asio/local/detail/impl/endpoint.ipp | 2
branches/release/boost/asio/local/stream_protocol.hpp | 2
branches/release/boost/asio/placeholders.hpp | 2
branches/release/boost/asio/posix/basic_descriptor.hpp | 2
branches/release/boost/asio/posix/basic_stream_descriptor.hpp | 2
branches/release/boost/asio/posix/descriptor_base.hpp | 2
branches/release/boost/asio/posix/stream_descriptor.hpp | 2
branches/release/boost/asio/posix/stream_descriptor_service.hpp | 2
branches/release/boost/asio/raw_socket_service.hpp | 2
branches/release/boost/asio/read.hpp | 2
branches/release/boost/asio/read_at.hpp | 2
branches/release/boost/asio/read_until.hpp | 2
branches/release/boost/asio/seq_packet_socket_service.hpp | 2
branches/release/boost/asio/serial_port.hpp | 2
branches/release/boost/asio/serial_port_base.hpp | 2
branches/release/boost/asio/serial_port_service.hpp | 2
branches/release/boost/asio/signal_set.hpp | 2
branches/release/boost/asio/signal_set_service.hpp | 2
branches/release/boost/asio/socket_acceptor_service.hpp | 2
branches/release/boost/asio/socket_base.hpp | 2
branches/release/boost/asio/ssl.hpp | 2
branches/release/boost/asio/ssl/basic_context.hpp | 2
branches/release/boost/asio/ssl/context.hpp | 2
branches/release/boost/asio/ssl/context_base.hpp | 2
branches/release/boost/asio/ssl/context_service.hpp | 2
branches/release/boost/asio/ssl/detail/engine.hpp | 2
branches/release/boost/asio/ssl/detail/handshake_op.hpp | 2
branches/release/boost/asio/ssl/detail/impl/engine.ipp | 2
branches/release/boost/asio/ssl/detail/impl/openssl_init.ipp | 2
branches/release/boost/asio/ssl/detail/io.hpp | 2
branches/release/boost/asio/ssl/detail/openssl_init.hpp | 2
branches/release/boost/asio/ssl/detail/openssl_types.hpp | 2
branches/release/boost/asio/ssl/detail/password_callback.hpp | 2
branches/release/boost/asio/ssl/detail/read_op.hpp | 2
branches/release/boost/asio/ssl/detail/shutdown_op.hpp | 2
branches/release/boost/asio/ssl/detail/stream_core.hpp | 2
branches/release/boost/asio/ssl/detail/verify_callback.hpp | 2
branches/release/boost/asio/ssl/detail/write_op.hpp | 2
branches/release/boost/asio/ssl/error.hpp | 2
branches/release/boost/asio/ssl/impl/context.hpp | 2
branches/release/boost/asio/ssl/impl/context.ipp | 2
branches/release/boost/asio/ssl/impl/error.ipp | 2
branches/release/boost/asio/ssl/impl/rfc2818_verification.ipp | 2
branches/release/boost/asio/ssl/impl/src.hpp | 2
branches/release/boost/asio/ssl/old/basic_context.hpp | 2
branches/release/boost/asio/ssl/old/context_service.hpp | 2
branches/release/boost/asio/ssl/old/detail/openssl_context_service.hpp | 2
branches/release/boost/asio/ssl/old/detail/openssl_stream_service.hpp | 2
branches/release/boost/asio/ssl/old/stream.hpp | 2
branches/release/boost/asio/ssl/old/stream_service.hpp | 2
branches/release/boost/asio/ssl/rfc2818_verification.hpp | 2
branches/release/boost/asio/ssl/stream.hpp | 2
branches/release/boost/asio/ssl/stream_base.hpp | 2
branches/release/boost/asio/ssl/stream_service.hpp | 2
branches/release/boost/asio/ssl/verify_context.hpp | 2
branches/release/boost/asio/ssl/verify_mode.hpp | 2
branches/release/boost/asio/strand.hpp | 2
branches/release/boost/asio/stream_socket_service.hpp | 2
branches/release/boost/asio/streambuf.hpp | 2
branches/release/boost/asio/time_traits.hpp | 2
branches/release/boost/asio/version.hpp | 4
branches/release/boost/asio/windows/basic_handle.hpp | 4
branches/release/boost/asio/windows/basic_random_access_handle.hpp | 2
branches/release/boost/asio/windows/basic_stream_handle.hpp | 2
branches/release/boost/asio/windows/overlapped_ptr.hpp | 2
branches/release/boost/asio/windows/random_access_handle.hpp | 2
branches/release/boost/asio/windows/random_access_handle_service.hpp | 2
branches/release/boost/asio/windows/stream_handle.hpp | 2
branches/release/boost/asio/windows/stream_handle_service.hpp | 2
branches/release/boost/asio/write.hpp | 2
branches/release/boost/asio/write_at.hpp | 2
branches/release/libs/asio/doc/Jamfile.v2 | 2
branches/release/libs/asio/doc/asio.qbk | 4
branches/release/libs/asio/doc/doxy2qbk.pl | 2
branches/release/libs/asio/doc/examples.qbk | 2
branches/release/libs/asio/doc/history.qbk | 25
branches/release/libs/asio/doc/index.xml | 2
branches/release/libs/asio/doc/noncopyable_dox.txt | 2
branches/release/libs/asio/doc/overview.qbk | 4
branches/release/libs/asio/doc/overview/allocation.qbk | 2
branches/release/libs/asio/doc/overview/async.qbk | 2
branches/release/libs/asio/doc/overview/basics.qbk | 2
branches/release/libs/asio/doc/overview/bsd_sockets.qbk | 2
branches/release/libs/asio/doc/overview/buffers.qbk | 2
branches/release/libs/asio/doc/overview/cpp2011.qbk | 27
branches/release/libs/asio/doc/overview/handler_tracking.qbk | 2
branches/release/libs/asio/doc/overview/implementation.qbk | 2
branches/release/libs/asio/doc/overview/iostreams.qbk | 2
branches/release/libs/asio/doc/overview/line_based.qbk | 2
branches/release/libs/asio/doc/overview/posix.qbk | 2
branches/release/libs/asio/doc/overview/protocols.qbk | 2
branches/release/libs/asio/doc/overview/rationale.qbk | 2
branches/release/libs/asio/doc/overview/reactor.qbk | 2
branches/release/libs/asio/doc/overview/serial_ports.qbk | 2
branches/release/libs/asio/doc/overview/signals.qbk | 2
branches/release/libs/asio/doc/overview/ssl.qbk | 2
branches/release/libs/asio/doc/overview/strands.qbk | 2
branches/release/libs/asio/doc/overview/streams.qbk | 2
branches/release/libs/asio/doc/overview/threads.qbk | 2
branches/release/libs/asio/doc/overview/timers.qbk | 2
branches/release/libs/asio/doc/overview/windows.qbk | 43
branches/release/libs/asio/doc/quickref.xml | 14
branches/release/libs/asio/doc/reference.qbk | 48065 +++++++++++++++++++++------------------
branches/release/libs/asio/doc/reference.xsl | 19
branches/release/libs/asio/doc/requirements.qbk | 2
branches/release/libs/asio/doc/requirements/AcceptHandler.qbk | 2
branches/release/libs/asio/doc/requirements/AsyncRandomAccessReadDevice.qbk | 2
branches/release/libs/asio/doc/requirements/AsyncRandomAccessWriteDevice.qbk | 2
branches/release/libs/asio/doc/requirements/AsyncReadStream.qbk | 2
branches/release/libs/asio/doc/requirements/AsyncWriteStream.qbk | 2
branches/release/libs/asio/doc/requirements/CompletionHandler.qbk | 2
branches/release/libs/asio/doc/requirements/ComposedConnectHandler.qbk | 2
branches/release/libs/asio/doc/requirements/ConnectHandler.qbk | 2
branches/release/libs/asio/doc/requirements/ConstBufferSequence.qbk | 2
branches/release/libs/asio/doc/requirements/ConvertibleToConstBuffer.qbk | 2
branches/release/libs/asio/doc/requirements/ConvertibleToMutableBuffer.qbk | 2
branches/release/libs/asio/doc/requirements/DatagramSocketService.qbk | 2
branches/release/libs/asio/doc/requirements/DescriptorService.qbk | 2
branches/release/libs/asio/doc/requirements/Endpoint.qbk | 2
branches/release/libs/asio/doc/requirements/GettableSerialPortOption.qbk | 2
branches/release/libs/asio/doc/requirements/GettableSocketOption.qbk | 2
branches/release/libs/asio/doc/requirements/HandleService.qbk | 2
branches/release/libs/asio/doc/requirements/Handler.qbk | 2
branches/release/libs/asio/doc/requirements/HandshakeHandler.qbk | 2
branches/release/libs/asio/doc/requirements/InternetProtocol.qbk | 2
branches/release/libs/asio/doc/requirements/IoControlCommand.qbk | 2
branches/release/libs/asio/doc/requirements/IoObjectService.qbk | 2
branches/release/libs/asio/doc/requirements/MutableBufferSequence.qbk | 2
branches/release/libs/asio/doc/requirements/Protocol.qbk | 2
branches/release/libs/asio/doc/requirements/RandomAccessHandleService.qbk | 2
branches/release/libs/asio/doc/requirements/RawSocketService.qbk | 2
branches/release/libs/asio/doc/requirements/ReadHandler.qbk | 2
branches/release/libs/asio/doc/requirements/ResolveHandler.qbk | 2
branches/release/libs/asio/doc/requirements/ResolverService.qbk | 2
branches/release/libs/asio/doc/requirements/SeqPacketSocketService.qbk | 2
branches/release/libs/asio/doc/requirements/SerialPortService.qbk | 2
branches/release/libs/asio/doc/requirements/Service.qbk | 2
branches/release/libs/asio/doc/requirements/SettableSerialPortOption.qbk | 2
branches/release/libs/asio/doc/requirements/SettableSocketOption.qbk | 2
branches/release/libs/asio/doc/requirements/ShutdownHandler.qbk | 2
branches/release/libs/asio/doc/requirements/SignalHandler.qbk | 2
branches/release/libs/asio/doc/requirements/SignalSetService.qbk | 2
branches/release/libs/asio/doc/requirements/SocketAcceptorService.qbk | 2
branches/release/libs/asio/doc/requirements/SocketService.qbk | 2
branches/release/libs/asio/doc/requirements/StreamDescriptorService.qbk | 2
branches/release/libs/asio/doc/requirements/StreamHandleService.qbk | 2
branches/release/libs/asio/doc/requirements/StreamSocketService.qbk | 2
branches/release/libs/asio/doc/requirements/SyncRandomAccessReadDevice.qbk | 2
branches/release/libs/asio/doc/requirements/SyncRandomAccessWriteDevice.qbk | 2
branches/release/libs/asio/doc/requirements/SyncReadStream.qbk | 2
branches/release/libs/asio/doc/requirements/SyncWriteStream.qbk | 2
branches/release/libs/asio/doc/requirements/TimeTraits.qbk | 2
branches/release/libs/asio/doc/requirements/TimerService.qbk | 2
branches/release/libs/asio/doc/requirements/WaitHandler.qbk | 2
branches/release/libs/asio/doc/requirements/WriteHandler.qbk | 2
branches/release/libs/asio/doc/requirements/asynchronous_operations.qbk | 2
branches/release/libs/asio/doc/std_exception_dox.txt | 2
branches/release/libs/asio/doc/tutorial.qbk | 26
branches/release/libs/asio/doc/tutorial.xsl | 4
branches/release/libs/asio/doc/using.qbk | 2
branches/release/libs/asio/example/allocation/Jamfile | 2
branches/release/libs/asio/example/allocation/Jamfile.v2 | 2
branches/release/libs/asio/example/allocation/server.cpp | 2
branches/release/libs/asio/example/buffers/Jamfile | 2
branches/release/libs/asio/example/buffers/Jamfile.v2 | 2
branches/release/libs/asio/example/buffers/reference_counted.cpp | 2
branches/release/libs/asio/example/chat/Jamfile | 2
branches/release/libs/asio/example/chat/Jamfile.v2 | 2
branches/release/libs/asio/example/chat/chat_client.cpp | 2
branches/release/libs/asio/example/chat/chat_message.hpp | 2
branches/release/libs/asio/example/chat/chat_server.cpp | 2
branches/release/libs/asio/example/chat/posix_chat_client.cpp | 2
branches/release/libs/asio/example/echo/Jamfile | 2
branches/release/libs/asio/example/echo/Jamfile.v2 | 2
branches/release/libs/asio/example/echo/async_tcp_echo_server.cpp | 2
branches/release/libs/asio/example/echo/async_udp_echo_server.cpp | 2
branches/release/libs/asio/example/echo/blocking_tcp_echo_client.cpp | 2
branches/release/libs/asio/example/echo/blocking_tcp_echo_server.cpp | 2
branches/release/libs/asio/example/echo/blocking_udp_echo_client.cpp | 2
branches/release/libs/asio/example/echo/blocking_udp_echo_server.cpp | 2
branches/release/libs/asio/example/fork/Jamfile | 2
branches/release/libs/asio/example/fork/Jamfile.v2 | 2
branches/release/libs/asio/example/fork/daemon.cpp | 2
branches/release/libs/asio/example/fork/process_per_connection.cpp | 2
branches/release/libs/asio/example/http/client/Jamfile | 2
branches/release/libs/asio/example/http/client/Jamfile.v2 | 2
branches/release/libs/asio/example/http/client/async_client.cpp | 2
branches/release/libs/asio/example/http/client/sync_client.cpp | 2
branches/release/libs/asio/example/http/doc_root/data_1K.html | 2
branches/release/libs/asio/example/http/doc_root/data_2K.html | 2
branches/release/libs/asio/example/http/doc_root/data_4K.html | 2
branches/release/libs/asio/example/http/doc_root/data_8K.html | 2
branches/release/libs/asio/example/http/server/Jamfile | 2
branches/release/libs/asio/example/http/server/Jamfile.v2 | 2
branches/release/libs/asio/example/http/server/connection.cpp | 2
branches/release/libs/asio/example/http/server/connection.hpp | 2
branches/release/libs/asio/example/http/server/connection_manager.cpp | 2
branches/release/libs/asio/example/http/server/connection_manager.hpp | 2
branches/release/libs/asio/example/http/server/header.hpp | 2
branches/release/libs/asio/example/http/server/main.cpp | 2
branches/release/libs/asio/example/http/server/mime_types.cpp | 2
branches/release/libs/asio/example/http/server/mime_types.hpp | 2
branches/release/libs/asio/example/http/server/reply.cpp | 2
branches/release/libs/asio/example/http/server/reply.hpp | 2
branches/release/libs/asio/example/http/server/request.hpp | 2
branches/release/libs/asio/example/http/server/request_handler.cpp | 2
branches/release/libs/asio/example/http/server/request_handler.hpp | 2
branches/release/libs/asio/example/http/server/request_parser.cpp | 2
branches/release/libs/asio/example/http/server/request_parser.hpp | 2
branches/release/libs/asio/example/http/server/server.cpp | 2
branches/release/libs/asio/example/http/server/server.hpp | 2
branches/release/libs/asio/example/http/server2/Jamfile | 2
branches/release/libs/asio/example/http/server2/Jamfile.v2 | 2
branches/release/libs/asio/example/http/server2/connection.cpp | 2
branches/release/libs/asio/example/http/server2/connection.hpp | 2
branches/release/libs/asio/example/http/server2/header.hpp | 2
branches/release/libs/asio/example/http/server2/io_service_pool.cpp | 2
branches/release/libs/asio/example/http/server2/io_service_pool.hpp | 2
branches/release/libs/asio/example/http/server2/main.cpp | 2
branches/release/libs/asio/example/http/server2/mime_types.cpp | 2
branches/release/libs/asio/example/http/server2/mime_types.hpp | 2
branches/release/libs/asio/example/http/server2/reply.cpp | 2
branches/release/libs/asio/example/http/server2/reply.hpp | 2
branches/release/libs/asio/example/http/server2/request.hpp | 2
branches/release/libs/asio/example/http/server2/request_handler.cpp | 2
branches/release/libs/asio/example/http/server2/request_handler.hpp | 2
branches/release/libs/asio/example/http/server2/request_parser.cpp | 2
branches/release/libs/asio/example/http/server2/request_parser.hpp | 2
branches/release/libs/asio/example/http/server2/server.cpp | 2
branches/release/libs/asio/example/http/server2/server.hpp | 2
branches/release/libs/asio/example/http/server3/Jamfile | 2
branches/release/libs/asio/example/http/server3/Jamfile.v2 | 2
branches/release/libs/asio/example/http/server3/connection.cpp | 2
branches/release/libs/asio/example/http/server3/connection.hpp | 2
branches/release/libs/asio/example/http/server3/header.hpp | 2
branches/release/libs/asio/example/http/server3/main.cpp | 2
branches/release/libs/asio/example/http/server3/mime_types.cpp | 2
branches/release/libs/asio/example/http/server3/mime_types.hpp | 2
branches/release/libs/asio/example/http/server3/reply.cpp | 2
branches/release/libs/asio/example/http/server3/reply.hpp | 2
branches/release/libs/asio/example/http/server3/request.hpp | 2
branches/release/libs/asio/example/http/server3/request_handler.cpp | 2
branches/release/libs/asio/example/http/server3/request_handler.hpp | 2
branches/release/libs/asio/example/http/server3/request_parser.cpp | 2
branches/release/libs/asio/example/http/server3/request_parser.hpp | 2
branches/release/libs/asio/example/http/server3/server.cpp | 2
branches/release/libs/asio/example/http/server3/server.hpp | 2
branches/release/libs/asio/example/http/server4/Jamfile | 2
branches/release/libs/asio/example/http/server4/Jamfile.v2 | 2
branches/release/libs/asio/example/http/server4/coroutine.hpp | 2
branches/release/libs/asio/example/http/server4/file_handler.cpp | 2
branches/release/libs/asio/example/http/server4/file_handler.hpp | 2
branches/release/libs/asio/example/http/server4/header.hpp | 2
branches/release/libs/asio/example/http/server4/main.cpp | 2
branches/release/libs/asio/example/http/server4/mime_types.cpp | 2
branches/release/libs/asio/example/http/server4/mime_types.hpp | 2
branches/release/libs/asio/example/http/server4/reply.cpp | 2
branches/release/libs/asio/example/http/server4/reply.hpp | 2
branches/release/libs/asio/example/http/server4/request.hpp | 2
branches/release/libs/asio/example/http/server4/request_parser.cpp | 2
branches/release/libs/asio/example/http/server4/request_parser.hpp | 2
branches/release/libs/asio/example/http/server4/server.cpp | 2
branches/release/libs/asio/example/http/server4/server.hpp | 2
branches/release/libs/asio/example/http/server4/unyield.hpp | 2
branches/release/libs/asio/example/http/server4/yield.hpp | 2
branches/release/libs/asio/example/icmp/Jamfile | 2
branches/release/libs/asio/example/icmp/Jamfile.v2 | 2
branches/release/libs/asio/example/icmp/icmp_header.hpp | 2
branches/release/libs/asio/example/icmp/ipv4_header.hpp | 2
branches/release/libs/asio/example/icmp/ping.cpp | 2
branches/release/libs/asio/example/invocation/Jamfile | 2
branches/release/libs/asio/example/invocation/Jamfile.v2 | 2
branches/release/libs/asio/example/invocation/prioritised_handlers.cpp | 2
branches/release/libs/asio/example/iostreams/Jamfile | 2
branches/release/libs/asio/example/iostreams/Jamfile.v2 | 2
branches/release/libs/asio/example/iostreams/daytime_client.cpp | 2
branches/release/libs/asio/example/iostreams/daytime_server.cpp | 2
branches/release/libs/asio/example/iostreams/http_client.cpp | 2
branches/release/libs/asio/example/local/Jamfile | 2
branches/release/libs/asio/example/local/Jamfile.v2 | 2
branches/release/libs/asio/example/local/connect_pair.cpp | 2
branches/release/libs/asio/example/local/iostream_client.cpp | 2
branches/release/libs/asio/example/local/stream_client.cpp | 2
branches/release/libs/asio/example/local/stream_server.cpp | 2
branches/release/libs/asio/example/multicast/Jamfile | 2
branches/release/libs/asio/example/multicast/Jamfile.v2 | 2
branches/release/libs/asio/example/multicast/receiver.cpp | 2
branches/release/libs/asio/example/multicast/sender.cpp | 2
branches/release/libs/asio/example/nonblocking/Jamfile | 2
branches/release/libs/asio/example/nonblocking/Jamfile.v2 | 2
branches/release/libs/asio/example/nonblocking/third_party_lib.cpp | 2
branches/release/libs/asio/example/porthopper/Jamfile | 2
branches/release/libs/asio/example/porthopper/Jamfile.v2 | 2
branches/release/libs/asio/example/porthopper/client.cpp | 2
branches/release/libs/asio/example/porthopper/protocol.hpp | 2
branches/release/libs/asio/example/porthopper/server.cpp | 2
branches/release/libs/asio/example/serialization/Jamfile | 2
branches/release/libs/asio/example/serialization/Jamfile.v2 | 2
branches/release/libs/asio/example/serialization/client.cpp | 2
branches/release/libs/asio/example/serialization/connection.hpp | 2
branches/release/libs/asio/example/serialization/server.cpp | 2
branches/release/libs/asio/example/serialization/stock.hpp | 2
branches/release/libs/asio/example/services/Jamfile | 2
branches/release/libs/asio/example/services/Jamfile.v2 | 2
branches/release/libs/asio/example/services/basic_logger.hpp | 2
branches/release/libs/asio/example/services/daytime_client.cpp | 2
branches/release/libs/asio/example/services/logger.hpp | 2
branches/release/libs/asio/example/services/logger_service.cpp | 2
branches/release/libs/asio/example/services/logger_service.hpp | 2
branches/release/libs/asio/example/services/stream_socket_service.hpp | 2
branches/release/libs/asio/example/socks4/Jamfile | 2
branches/release/libs/asio/example/socks4/Jamfile.v2 | 2
branches/release/libs/asio/example/socks4/socks4.hpp | 2
branches/release/libs/asio/example/socks4/sync_client.cpp | 2
branches/release/libs/asio/example/ssl/Jamfile | 2
branches/release/libs/asio/example/ssl/Jamfile.v2 | 2
branches/release/libs/asio/example/ssl/README | 2
branches/release/libs/asio/example/ssl/client.cpp | 2
branches/release/libs/asio/example/ssl/server.cpp | 2
branches/release/libs/asio/example/timeouts/Jamfile | 2
branches/release/libs/asio/example/timeouts/Jamfile.v2 | 2
branches/release/libs/asio/example/timeouts/async_tcp_client.cpp | 2
branches/release/libs/asio/example/timeouts/blocking_tcp_client.cpp | 2
branches/release/libs/asio/example/timeouts/blocking_udp_client.cpp | 2
branches/release/libs/asio/example/timeouts/server.cpp | 2
branches/release/libs/asio/example/timers/Jamfile | 2
branches/release/libs/asio/example/timers/Jamfile.v2 | 2
branches/release/libs/asio/example/timers/tick_count_timer.cpp | 2
branches/release/libs/asio/example/timers/time_t_timer.cpp | 2
branches/release/libs/asio/example/tutorial/Jamfile | 2
branches/release/libs/asio/example/tutorial/Jamfile.v2 | 2
branches/release/libs/asio/example/tutorial/daytime1/client.cpp | 2
branches/release/libs/asio/example/tutorial/daytime2/server.cpp | 2
branches/release/libs/asio/example/tutorial/daytime3/server.cpp | 2
branches/release/libs/asio/example/tutorial/daytime4/client.cpp | 2
branches/release/libs/asio/example/tutorial/daytime5/server.cpp | 2
branches/release/libs/asio/example/tutorial/daytime6/server.cpp | 2
branches/release/libs/asio/example/tutorial/daytime7/server.cpp | 2
branches/release/libs/asio/example/tutorial/daytime_dox.txt | 12
branches/release/libs/asio/example/tutorial/index_dox.txt | 2
branches/release/libs/asio/example/tutorial/timer1/timer.cpp | 2
branches/release/libs/asio/example/tutorial/timer2/timer.cpp | 2
branches/release/libs/asio/example/tutorial/timer3/timer.cpp | 2
branches/release/libs/asio/example/tutorial/timer4/timer.cpp | 2
branches/release/libs/asio/example/tutorial/timer5/timer.cpp | 2
branches/release/libs/asio/example/tutorial/timer_dox.txt | 2
branches/release/libs/asio/example/windows/Jamfile | 2
branches/release/libs/asio/example/windows/Jamfile.v2 | 2
branches/release/libs/asio/example/windows/transmit_file.cpp | 2
branches/release/libs/asio/test/Jamfile | 2
branches/release/libs/asio/test/Jamfile.v2 | 20
branches/release/libs/asio/test/archetypes/gettable_socket_option.hpp | 2
branches/release/libs/asio/test/archetypes/io_control_command.hpp | 2
branches/release/libs/asio/test/archetypes/settable_socket_option.hpp | 2
branches/release/libs/asio/test/basic_datagram_socket.cpp | 2
branches/release/libs/asio/test/basic_deadline_timer.cpp | 2
branches/release/libs/asio/test/basic_raw_socket.cpp | 2
branches/release/libs/asio/test/basic_seq_packet_socket.cpp | 2
branches/release/libs/asio/test/basic_serial_port.cpp | 2
branches/release/libs/asio/test/basic_signal_set.cpp | 2
branches/release/libs/asio/test/basic_socket_acceptor.cpp | 2
branches/release/libs/asio/test/basic_stream_socket.cpp | 2
branches/release/libs/asio/test/basic_streambuf.cpp | 2
branches/release/libs/asio/test/buffer.cpp | 2
branches/release/libs/asio/test/buffered_read_stream.cpp | 2
branches/release/libs/asio/test/buffered_stream.cpp | 2
branches/release/libs/asio/test/buffered_write_stream.cpp | 2
branches/release/libs/asio/test/buffers_iterator.cpp | 2
branches/release/libs/asio/test/completion_condition.cpp | 2
branches/release/libs/asio/test/connect.cpp | 2
branches/release/libs/asio/test/datagram_socket_service.cpp | 2
branches/release/libs/asio/test/deadline_timer.cpp | 2
branches/release/libs/asio/test/deadline_timer_service.cpp | 2
branches/release/libs/asio/test/error.cpp | 2
branches/release/libs/asio/test/io_service.cpp | 2
branches/release/libs/asio/test/ip/address.cpp | 2
branches/release/libs/asio/test/ip/address_v4.cpp | 2
branches/release/libs/asio/test/ip/address_v6.cpp | 2
branches/release/libs/asio/test/ip/basic_endpoint.cpp | 2
branches/release/libs/asio/test/ip/basic_resolver.cpp | 2
branches/release/libs/asio/test/ip/basic_resolver_entry.cpp | 2
branches/release/libs/asio/test/ip/basic_resolver_iterator.cpp | 2
branches/release/libs/asio/test/ip/basic_resolver_query.cpp | 2
branches/release/libs/asio/test/ip/host_name.cpp | 2
branches/release/libs/asio/test/ip/multicast.cpp | 2
branches/release/libs/asio/test/ip/resolver_query_base.cpp | 2
branches/release/libs/asio/test/ip/resolver_service.cpp | 2
branches/release/libs/asio/test/ip/tcp.cpp | 2
branches/release/libs/asio/test/ip/udp.cpp | 2
branches/release/libs/asio/test/ip/unicast.cpp | 2
branches/release/libs/asio/test/ip/v6_only.cpp | 2
branches/release/libs/asio/test/is_read_buffered.cpp | 2
branches/release/libs/asio/test/is_write_buffered.cpp | 2
branches/release/libs/asio/test/latency/Jamfile.v2 | 2
branches/release/libs/asio/test/latency/allocator.hpp | 2
branches/release/libs/asio/test/latency/coroutine.hpp | 2
branches/release/libs/asio/test/latency/high_res_clock.hpp | 2
branches/release/libs/asio/test/latency/tcp_client.cpp | 2
branches/release/libs/asio/test/latency/tcp_server.cpp | 2
branches/release/libs/asio/test/latency/udp_client.cpp | 2
branches/release/libs/asio/test/latency/udp_server.cpp | 2
branches/release/libs/asio/test/latency/unyield.hpp | 2
branches/release/libs/asio/test/latency/yield.hpp | 2
branches/release/libs/asio/test/local/basic_endpoint.cpp | 2
branches/release/libs/asio/test/local/connect_pair.cpp | 2
branches/release/libs/asio/test/local/datagram_protocol.cpp | 2
branches/release/libs/asio/test/local/stream_protocol.cpp | 2
branches/release/libs/asio/test/placeholders.cpp | 2
branches/release/libs/asio/test/posix/basic_descriptor.cpp | 2
branches/release/libs/asio/test/posix/basic_stream_descriptor.cpp | 2
branches/release/libs/asio/test/posix/descriptor_base.cpp | 2
branches/release/libs/asio/test/posix/stream_descriptor.cpp | 2
branches/release/libs/asio/test/posix/stream_descriptor_service.cpp | 2
branches/release/libs/asio/test/raw_socket_service.cpp | 2
branches/release/libs/asio/test/read.cpp | 2
branches/release/libs/asio/test/read_at.cpp | 2
branches/release/libs/asio/test/read_until.cpp | 2
branches/release/libs/asio/test/seq_packet_socket_service.cpp | 2
branches/release/libs/asio/test/serial_port.cpp | 2
branches/release/libs/asio/test/serial_port_base.cpp | 2
branches/release/libs/asio/test/serial_port_service.cpp | 2
branches/release/libs/asio/test/signal_set.cpp | 2
branches/release/libs/asio/test/signal_set_service.cpp | 2
branches/release/libs/asio/test/socket_acceptor_service.cpp | 2
branches/release/libs/asio/test/socket_base.cpp | 2
branches/release/libs/asio/test/ssl/Jamfile | 2
branches/release/libs/asio/test/ssl/Jamfile.v2 | 2
branches/release/libs/asio/test/ssl/basic_context.cpp | 2
branches/release/libs/asio/test/ssl/context.cpp | 2
branches/release/libs/asio/test/ssl/context_base.cpp | 2
branches/release/libs/asio/test/ssl/context_service.cpp | 2
branches/release/libs/asio/test/ssl/rfc2818_verification.cpp | 2
branches/release/libs/asio/test/ssl/stream.cpp | 2
branches/release/libs/asio/test/ssl/stream_base.cpp | 2
branches/release/libs/asio/test/ssl/stream_service.cpp | 2
branches/release/libs/asio/test/strand.cpp | 2
branches/release/libs/asio/test/stream_socket_service.cpp | 2
branches/release/libs/asio/test/streambuf.cpp | 2
branches/release/libs/asio/test/time_traits.cpp | 2
branches/release/libs/asio/test/unit_test.hpp | 2
branches/release/libs/asio/test/windows/basic_handle.cpp | 2
branches/release/libs/asio/test/windows/basic_random_access_handle.cpp | 2
branches/release/libs/asio/test/windows/basic_stream_handle.cpp | 2
branches/release/libs/asio/test/windows/overlapped_ptr.cpp | 2
branches/release/libs/asio/test/windows/random_access_handle.cpp | 2
branches/release/libs/asio/test/windows/random_access_handle_service.cpp | 2
branches/release/libs/asio/test/windows/stream_handle.cpp | 2
branches/release/libs/asio/test/windows/stream_handle_service.cpp | 2
branches/release/libs/asio/test/write.cpp | 2
branches/release/libs/asio/test/write_at.cpp | 2
716 files changed, 27246 insertions(+), 22703 deletions(-)
Modified: branches/release/boost/asio.hpp
==============================================================================
--- branches/release/boost/asio.hpp (original)
+++ branches/release/boost/asio.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// asio.hpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -29,6 +29,7 @@
#include <boost/asio/basic_socket_streambuf.hpp>
#include <boost/asio/basic_stream_socket.hpp>
#include <boost/asio/basic_streambuf.hpp>
+#include <boost/asio/basic_waitable_timer.hpp>
#include <boost/asio/buffer.hpp>
#include <boost/asio/buffered_read_stream_fwd.hpp>
#include <boost/asio/buffered_read_stream.hpp>
@@ -92,9 +93,14 @@
#include <boost/asio/streambuf.hpp>
#include <boost/asio/time_traits.hpp>
#include <boost/asio/version.hpp>
+#include <boost/asio/wait_traits.hpp>
+#include <boost/asio/waitable_timer_service.hpp>
#include <boost/asio/windows/basic_handle.hpp>
+#include <boost/asio/windows/basic_object_handle.hpp>
#include <boost/asio/windows/basic_random_access_handle.hpp>
#include <boost/asio/windows/basic_stream_handle.hpp>
+#include <boost/asio/windows/object_handle.hpp>
+#include <boost/asio/windows/object_handle_service.hpp>
#include <boost/asio/windows/overlapped_ptr.hpp>
#include <boost/asio/windows/random_access_handle.hpp>
#include <boost/asio/windows/random_access_handle_service.hpp>
Modified: branches/release/boost/asio/basic_datagram_socket.hpp
==============================================================================
--- branches/release/boost/asio/basic_datagram_socket.hpp (original)
+++ branches/release/boost/asio/basic_datagram_socket.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_datagram_socket.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_deadline_timer.hpp
==============================================================================
--- branches/release/boost/asio/basic_deadline_timer.hpp (original)
+++ branches/release/boost/asio/basic_deadline_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_deadline_timer.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_io_object.hpp
==============================================================================
--- branches/release/boost/asio/basic_io_object.hpp (original)
+++ branches/release/boost/asio/basic_io_object.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_io_object.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_raw_socket.hpp
==============================================================================
--- branches/release/boost/asio/basic_raw_socket.hpp (original)
+++ branches/release/boost/asio/basic_raw_socket.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_raw_socket.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_seq_packet_socket.hpp
==============================================================================
--- branches/release/boost/asio/basic_seq_packet_socket.hpp (original)
+++ branches/release/boost/asio/basic_seq_packet_socket.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_seq_packet_socket.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_serial_port.hpp
==============================================================================
--- branches/release/boost/asio/basic_serial_port.hpp (original)
+++ branches/release/boost/asio/basic_serial_port.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_serial_port.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/basic_signal_set.hpp
==============================================================================
--- branches/release/boost/asio/basic_signal_set.hpp (original)
+++ branches/release/boost/asio/basic_signal_set.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_signal_set.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_socket.hpp
==============================================================================
--- branches/release/boost/asio/basic_socket.hpp (original)
+++ branches/release/boost/asio/basic_socket.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_socket.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_socket_acceptor.hpp
==============================================================================
--- branches/release/boost/asio/basic_socket_acceptor.hpp (original)
+++ branches/release/boost/asio/basic_socket_acceptor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_socket_acceptor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_socket_iostream.hpp
==============================================================================
--- branches/release/boost/asio/basic_socket_iostream.hpp (original)
+++ branches/release/boost/asio/basic_socket_iostream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_socket_iostream.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_socket_streambuf.hpp
==============================================================================
--- branches/release/boost/asio/basic_socket_streambuf.hpp (original)
+++ branches/release/boost/asio/basic_socket_streambuf.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_socket_streambuf.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_stream_socket.hpp
==============================================================================
--- branches/release/boost/asio/basic_stream_socket.hpp (original)
+++ branches/release/boost/asio/basic_stream_socket.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_stream_socket.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_streambuf.hpp
==============================================================================
--- branches/release/boost/asio/basic_streambuf.hpp (original)
+++ branches/release/boost/asio/basic_streambuf.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_streambuf.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/basic_streambuf_fwd.hpp
==============================================================================
--- branches/release/boost/asio/basic_streambuf_fwd.hpp (original)
+++ branches/release/boost/asio/basic_streambuf_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_streambuf_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/basic_waitable_timer.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/basic_waitable_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,518 @@
+//
+// basic_waitable_timer.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_WAITABLE_TIMER_HPP
+#define BOOST_ASIO_BASIC_WAITABLE_TIMER_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+#include <cstddef>
+#include <boost/asio/basic_io_object.hpp>
+#include <boost/asio/detail/handler_type_requirements.hpp>
+#include <boost/asio/detail/throw_error.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/wait_traits.hpp>
+#include <boost/asio/waitable_timer_service.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+
+/// Provides waitable timer functionality.
+/**
+ * The basic_waitable_timer class template provides the ability to perform a
+ * blocking or asynchronous wait for a timer to expire.
+ *
+ * A waitable timer is always in one of two states: "expired" or "not expired".
+ * If the wait() or async_wait() function is called on an expired timer, the
+ * wait operation will complete immediately.
+ *
+ * Most applications will use the boost::asio::waitable_timer typedef.
+ *
+ * @note This waitable timer functionality is for use with the C++11 standard
+ * library's @c <chrono> facility, or with the Boost.Chrono library.
+ *
+ * @par Thread Safety
+ * @e Distinct @e objects: Safe._at_n
+ * @e Shared @e objects: Unsafe.
+ *
+ * @par Examples
+ * Performing a blocking wait:
+ * @code
+ * // Construct a timer without setting an expiry time.
+ * boost::asio::waitable_timer timer(io_service);
+ *
+ * // Set an expiry time relative to now.
+ * timer.expires_from_now(boost::posix_time::seconds(5));
+ *
+ * // Wait for the timer to expire.
+ * timer.wait();
+ * @endcode
+ *
+ * @par
+ * Performing an asynchronous wait:
+ * @code
+ * void handler(const boost::system::error_code& error)
+ * {
+ * if (!error)
+ * {
+ * // Timer expired.
+ * }
+ * }
+ *
+ * ...
+ *
+ * // Construct a timer with an absolute expiry time.
+ * boost::asio::waitable_timer timer(io_service,
+ * boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+ *
+ * // Start an asynchronous wait.
+ * timer.async_wait(handler);
+ * @endcode
+ *
+ * @par Changing an active waitable_timer's expiry time
+ *
+ * Changing the expiry time of a timer while there are pending asynchronous
+ * waits causes those wait operations to be cancelled. To ensure that the action
+ * associated with the timer is performed only once, use something like this:
+ * used:
+ *
+ * @code
+ * void on_some_event()
+ * {
+ * if (my_timer.expires_from_now(seconds(5)) > 0)
+ * {
+ * // We managed to cancel the timer. Start new asynchronous wait.
+ * my_timer.async_wait(on_timeout);
+ * }
+ * else
+ * {
+ * // Too late, timer has already expired!
+ * }
+ * }
+ *
+ * void on_timeout(const boost::system::error_code& e)
+ * {
+ * if (e != boost::asio::error::operation_aborted)
+ * {
+ * // Timer was not cancelled, take necessary action.
+ * }
+ * }
+ * @endcode
+ *
+ * @li The boost::asio::basic_waitable_timer::expires_from_now() function
+ * cancels any pending asynchronous waits, and returns the number of
+ * asynchronous waits that were cancelled. If it returns 0 then you were too
+ * late and the wait handler has already been executed, or will soon be
+ * executed. If it returns 1 then the wait handler was successfully cancelled.
+ *
+ * @li If a wait handler is cancelled, the boost::system::error_code passed to
+ * it contains the value boost::asio::error::operation_aborted.
+ */
+template <typename Clock,
+ typename WaitTraits = boost::asio::wait_traits<Clock>,
+ typename WaitableTimerService = waitable_timer_service<Clock, WaitTraits> >
+class basic_waitable_timer
+ : public basic_io_object<WaitableTimerService>
+{
+public:
+ /// The clock type.
+ typedef Clock clock_type;
+
+ /// The duration type of the clock.
+ typedef typename clock_type::duration duration;
+
+ /// The time point type of the clock.
+ typedef typename clock_type::time_point time_point;
+
+ /// The wait traits type.
+ typedef WaitTraits traits_type;
+
+ /// Constructor.
+ /**
+ * This constructor creates a timer without setting an expiry time. The
+ * expires_at() or expires_from_now() functions must be called to set an
+ * expiry time before the timer can be waited on.
+ *
+ * @param io_service The io_service object that the timer will use to dispatch
+ * handlers for any asynchronous operations performed on the timer.
+ */
+ explicit basic_waitable_timer(boost::asio::io_service& io_service)
+ : basic_io_object<WaitableTimerService>(io_service)
+ {
+ }
+
+ /// Constructor to set a particular expiry time as an absolute time.
+ /**
+ * This constructor creates a timer and sets the expiry time.
+ *
+ * @param io_service The io_service object that the timer will use to dispatch
+ * handlers for any asynchronous operations performed on the timer.
+ *
+ * @param expiry_time The expiry time to be used for the timer, expressed
+ * as an absolute time.
+ */
+ basic_waitable_timer(boost::asio::io_service& io_service,
+ const time_point& expiry_time)
+ : basic_io_object<WaitableTimerService>(io_service)
+ {
+ boost::system::error_code ec;
+ this->service.expires_at(this->implementation, expiry_time, ec);
+ boost::asio::detail::throw_error(ec, "expires_at");
+ }
+
+ /// Constructor to set a particular expiry time relative to now.
+ /**
+ * This constructor creates a timer and sets the expiry time.
+ *
+ * @param io_service The io_service object that the timer will use to dispatch
+ * handlers for any asynchronous operations performed on the timer.
+ *
+ * @param expiry_time The expiry time to be used for the timer, relative to
+ * now.
+ */
+ basic_waitable_timer(boost::asio::io_service& io_service,
+ const duration& expiry_time)
+ : basic_io_object<WaitableTimerService>(io_service)
+ {
+ boost::system::error_code ec;
+ this->service.expires_from_now(this->implementation, expiry_time, ec);
+ boost::asio::detail::throw_error(ec, "expires_from_now");
+ }
+
+ /// Cancel any asynchronous operations that are waiting on the timer.
+ /**
+ * This function forces the completion of any pending asynchronous wait
+ * operations against the timer. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * Cancelling the timer does not change the expiry time.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ *
+ * @note If the timer has already expired when cancel() is called, then the
+ * handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t cancel()
+ {
+ boost::system::error_code ec;
+ std::size_t s = this->service.cancel(this->implementation, ec);
+ boost::asio::detail::throw_error(ec, "cancel");
+ return s;
+ }
+
+ /// Cancel any asynchronous operations that are waiting on the timer.
+ /**
+ * This function forces the completion of any pending asynchronous wait
+ * operations against the timer. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * Cancelling the timer does not change the expiry time.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @note If the timer has already expired when cancel() is called, then the
+ * handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t cancel(boost::system::error_code& ec)
+ {
+ return this->service.cancel(this->implementation, ec);
+ }
+
+ /// Cancels one asynchronous operation that is waiting on the timer.
+ /**
+ * This function forces the completion of one pending asynchronous wait
+ * operation against the timer. Handlers are cancelled in FIFO order. The
+ * handler for the cancelled operation will be invoked with the
+ * boost::asio::error::operation_aborted error code.
+ *
+ * Cancelling the timer does not change the expiry time.
+ *
+ * @return The number of asynchronous operations that were cancelled. That is,
+ * either 0 or 1.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ *
+ * @note If the timer has already expired when cancel_one() is called, then
+ * the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t cancel_one()
+ {
+ boost::system::error_code ec;
+ std::size_t s = this->service.cancel_one(this->implementation, ec);
+ boost::asio::detail::throw_error(ec, "cancel_one");
+ return s;
+ }
+
+ /// Cancels one asynchronous operation that is waiting on the timer.
+ /**
+ * This function forces the completion of one pending asynchronous wait
+ * operation against the timer. Handlers are cancelled in FIFO order. The
+ * handler for the cancelled operation will be invoked with the
+ * boost::asio::error::operation_aborted error code.
+ *
+ * Cancelling the timer does not change the expiry time.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ *
+ * @return The number of asynchronous operations that were cancelled. That is,
+ * either 0 or 1.
+ *
+ * @note If the timer has already expired when cancel_one() is called, then
+ * the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t cancel_one(boost::system::error_code& ec)
+ {
+ return this->service.cancel_one(this->implementation, ec);
+ }
+
+ /// Get the timer's expiry time as an absolute time.
+ /**
+ * This function may be used to obtain the timer's current expiry time.
+ * Whether the timer has expired or not does not affect this value.
+ */
+ time_point expires_at() const
+ {
+ return this->service.expires_at(this->implementation);
+ }
+
+ /// Set the timer's expiry time as an absolute time.
+ /**
+ * This function sets the expiry time. Any pending asynchronous wait
+ * operations will be cancelled. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * @param expiry_time The expiry time to be used for the timer.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ *
+ * @note If the timer has already expired when expires_at() is called, then
+ * the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t expires_at(const time_point& expiry_time)
+ {
+ boost::system::error_code ec;
+ std::size_t s = this->service.expires_at(
+ this->implementation, expiry_time, ec);
+ boost::asio::detail::throw_error(ec, "expires_at");
+ return s;
+ }
+
+ /// Set the timer's expiry time as an absolute time.
+ /**
+ * This function sets the expiry time. Any pending asynchronous wait
+ * operations will be cancelled. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * @param expiry_time The expiry time to be used for the timer.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @note If the timer has already expired when expires_at() is called, then
+ * the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t expires_at(const time_point& expiry_time,
+ boost::system::error_code& ec)
+ {
+ return this->service.expires_at(this->implementation, expiry_time, ec);
+ }
+
+ /// Get the timer's expiry time relative to now.
+ /**
+ * This function may be used to obtain the timer's current expiry time.
+ * Whether the timer has expired or not does not affect this value.
+ */
+ duration expires_from_now() const
+ {
+ return this->service.expires_from_now(this->implementation);
+ }
+
+ /// Set the timer's expiry time relative to now.
+ /**
+ * This function sets the expiry time. Any pending asynchronous wait
+ * operations will be cancelled. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * @param expiry_time The expiry time to be used for the timer.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ *
+ * @note If the timer has already expired when expires_from_now() is called,
+ * then the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t expires_from_now(const duration& expiry_time)
+ {
+ boost::system::error_code ec;
+ std::size_t s = this->service.expires_from_now(
+ this->implementation, expiry_time, ec);
+ boost::asio::detail::throw_error(ec, "expires_from_now");
+ return s;
+ }
+
+ /// Set the timer's expiry time relative to now.
+ /**
+ * This function sets the expiry time. Any pending asynchronous wait
+ * operations will be cancelled. The handler for each cancelled operation will
+ * be invoked with the boost::asio::error::operation_aborted error code.
+ *
+ * @param expiry_time The expiry time to be used for the timer.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ *
+ * @return The number of asynchronous operations that were cancelled.
+ *
+ * @note If the timer has already expired when expires_from_now() is called,
+ * then the handlers for asynchronous wait operations will:
+ *
+ * @li have already been invoked; or
+ *
+ * @li have been queued for invocation in the near future.
+ *
+ * These handlers can no longer be cancelled, and therefore are passed an
+ * error code that indicates the successful completion of the wait operation.
+ */
+ std::size_t expires_from_now(const duration& expiry_time,
+ boost::system::error_code& ec)
+ {
+ return this->service.expires_from_now(
+ this->implementation, expiry_time, ec);
+ }
+
+ /// Perform a blocking wait on the timer.
+ /**
+ * This function is used to wait for the timer to expire. This function
+ * blocks and does not return until the timer has expired.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ void wait()
+ {
+ boost::system::error_code ec;
+ this->service.wait(this->implementation, ec);
+ boost::asio::detail::throw_error(ec, "wait");
+ }
+
+ /// Perform a blocking wait on the timer.
+ /**
+ * This function is used to wait for the timer to expire. This function
+ * blocks and does not return until the timer has expired.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ */
+ void wait(boost::system::error_code& ec)
+ {
+ this->service.wait(this->implementation, ec);
+ }
+
+ /// Start an asynchronous wait on the timer.
+ /**
+ * This function may be used to initiate an asynchronous wait against the
+ * timer. It always returns immediately.
+ *
+ * For each call to async_wait(), the supplied handler will be called exactly
+ * once. The handler will be called when:
+ *
+ * @li The timer has expired.
+ *
+ * @li The timer was cancelled, in which case the handler is passed the error
+ * code boost::asio::error::operation_aborted.
+ *
+ * @param handler The handler to be called when the timer expires. 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. Invocation
+ * of the handler will be performed in a manner equivalent to using
+ * boost::asio::io_service::post().
+ */
+ template <typename WaitHandler>
+ void async_wait(BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
+ {
+ // 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;
+
+ this->service.async_wait(this->implementation,
+ BOOST_ASIO_MOVE_CAST(WaitHandler)(handler));
+ }
+};
+
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_BASIC_WAITABLE_TIMER_HPP
Modified: branches/release/boost/asio/buffer.hpp
==============================================================================
--- branches/release/boost/asio/buffer.hpp (original)
+++ branches/release/boost/asio/buffer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffer.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffered_read_stream.hpp
==============================================================================
--- branches/release/boost/asio/buffered_read_stream.hpp (original)
+++ branches/release/boost/asio/buffered_read_stream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_read_stream.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffered_read_stream_fwd.hpp
==============================================================================
--- branches/release/boost/asio/buffered_read_stream_fwd.hpp (original)
+++ branches/release/boost/asio/buffered_read_stream_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_read_stream_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffered_stream.hpp
==============================================================================
--- branches/release/boost/asio/buffered_stream.hpp (original)
+++ branches/release/boost/asio/buffered_stream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_stream.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffered_stream_fwd.hpp
==============================================================================
--- branches/release/boost/asio/buffered_stream_fwd.hpp (original)
+++ branches/release/boost/asio/buffered_stream_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_stream_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffered_write_stream.hpp
==============================================================================
--- branches/release/boost/asio/buffered_write_stream.hpp (original)
+++ branches/release/boost/asio/buffered_write_stream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_write_stream.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -335,7 +335,8 @@
std::size_t bytes_avail = boost::asio::buffer_size(buffers);
std::size_t length = bytes_avail < space_avail ? bytes_avail : space_avail;
storage_.resize(orig_size + length);
- return boost::asio::buffer_copy(storage_.data(), buffers, length);
+ return boost::asio::buffer_copy(
+ storage_.data() + orig_size, buffers, length);
}
/// The next layer.
Modified: branches/release/boost/asio/buffered_write_stream_fwd.hpp
==============================================================================
--- branches/release/boost/asio/buffered_write_stream_fwd.hpp (original)
+++ branches/release/boost/asio/buffered_write_stream_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_write_stream_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/buffers_iterator.hpp
==============================================================================
--- branches/release/boost/asio/buffers_iterator.hpp (original)
+++ branches/release/boost/asio/buffers_iterator.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffers_iterator.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/completion_condition.hpp
==============================================================================
--- branches/release/boost/asio/completion_condition.hpp (original)
+++ branches/release/boost/asio/completion_condition.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// completion_condition.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/connect.hpp
==============================================================================
--- branches/release/boost/asio/connect.hpp (original)
+++ branches/release/boost/asio/connect.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connect.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/datagram_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/datagram_socket_service.hpp (original)
+++ branches/release/boost/asio/datagram_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// datagram_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/deadline_timer.hpp
==============================================================================
--- branches/release/boost/asio/deadline_timer.hpp (original)
+++ branches/release/boost/asio/deadline_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// deadline_timer.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/deadline_timer_service.hpp
==============================================================================
--- branches/release/boost/asio/deadline_timer_service.hpp (original)
+++ branches/release/boost/asio/deadline_timer_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// deadline_timer_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -20,6 +20,7 @@
#include <boost/asio/detail/deadline_timer_service.hpp>
#include <boost/asio/io_service.hpp>
#include <boost/asio/time_traits.hpp>
+#include <boost/asio/detail/timer_queue_ptime.hpp>
#include <boost/asio/detail/push_options.hpp>
Modified: branches/release/boost/asio/detail/array.hpp
==============================================================================
--- branches/release/boost/asio/detail/array.hpp (original)
+++ branches/release/boost/asio/detail/array.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/array.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/array_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/array_fwd.hpp (original)
+++ branches/release/boost/asio/detail/array_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/array_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/atomic_count.hpp
==============================================================================
--- branches/release/boost/asio/detail/atomic_count.hpp (original)
+++ branches/release/boost/asio/detail/atomic_count.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/atomic_count.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/base_from_completion_cond.hpp
==============================================================================
--- branches/release/boost/asio/detail/base_from_completion_cond.hpp (original)
+++ branches/release/boost/asio/detail/base_from_completion_cond.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/base_from_completion_cond.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/bind_handler.hpp
==============================================================================
--- branches/release/boost/asio/detail/bind_handler.hpp (original)
+++ branches/release/boost/asio/detail/bind_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/bind_handler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/buffer_resize_guard.hpp
==============================================================================
--- branches/release/boost/asio/detail/buffer_resize_guard.hpp (original)
+++ branches/release/boost/asio/detail/buffer_resize_guard.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/buffer_resize_guard.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/buffer_sequence_adapter.hpp
==============================================================================
--- branches/release/boost/asio/detail/buffer_sequence_adapter.hpp (original)
+++ branches/release/boost/asio/detail/buffer_sequence_adapter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/buffer_sequence_adapter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/buffered_stream_storage.hpp
==============================================================================
--- branches/release/boost/asio/detail/buffered_stream_storage.hpp (original)
+++ branches/release/boost/asio/detail/buffered_stream_storage.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/buffered_stream_storage.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/call_stack.hpp
==============================================================================
--- branches/release/boost/asio/detail/call_stack.hpp (original)
+++ branches/release/boost/asio/detail/call_stack.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/call_stack.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/chrono_time_traits.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/chrono_time_traits.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,129 @@
+//
+// detail/chrono_time_traits.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_DETAIL_CHRONO_TIME_TRAITS_HPP
+#define BOOST_ASIO_DETAIL_CHRONO_TIME_TRAITS_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/cstdint.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+// Adapts std::chrono clocks for use with a deadline timer.
+template <typename Clock, typename WaitTraits>
+struct chrono_time_traits
+{
+ // The clock type.
+ typedef Clock clock_type;
+
+ // The duration type of the clock.
+ typedef typename clock_type::duration duration_type;
+
+ // The time point type of the clock.
+ typedef typename clock_type::time_point time_type;
+
+ // The period of the clock.
+ typedef typename duration_type::period period_type;
+
+ // Get the current time.
+ static time_type now()
+ {
+ return clock_type::now();
+ }
+
+ // Add a duration to a time.
+ static time_type add(const time_type& t, const duration_type& d)
+ {
+ return t + d;
+ }
+
+ // Subtract one time from another.
+ static duration_type subtract(const time_type& t1, const time_type& t2)
+ {
+ return t1 - t2;
+ }
+
+ // Test whether one time is less than another.
+ static bool less_than(const time_type& t1, const time_type& t2)
+ {
+ return t1 < t2;
+ }
+
+ // Implement just enough of the posix_time::time_duration interface to supply
+ // what the timer_queue requires.
+ class posix_time_duration
+ {
+ public:
+ explicit posix_time_duration(const duration_type& d)
+ : d_(d)
+ {
+ }
+
+ boost::int64_t ticks() const
+ {
+ return d_.count();
+ }
+
+ boost::int64_t total_seconds() const
+ {
+ return duration_cast<1, 1>();
+ }
+
+ boost::int64_t total_milliseconds() const
+ {
+ return duration_cast<1, 1000>();
+ }
+
+ boost::int64_t total_microseconds() const
+ {
+ return duration_cast<1, 1000000>();
+ }
+
+ private:
+ template <boost::int64_t Num, boost::int64_t Den>
+ boost::int64_t duration_cast() const
+ {
+ const boost::int64_t num = period_type::num * Den;
+ const boost::int64_t den = period_type::den * Num;
+
+ if (num == 1 && den == 1)
+ return ticks();
+ else if (num != 1 && den == 1)
+ return ticks() * num;
+ else if (num == 1 && period_type::den != 1)
+ return ticks() / den;
+ else
+ return ticks() * num / den;
+ }
+
+ duration_type d_;
+ };
+
+ // Convert to POSIX duration type.
+ static posix_time_duration to_posix_duration(const duration_type& d)
+ {
+ return posix_time_duration(WaitTraits::to_wait_duration(d));
+ }
+};
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_DETAIL_CHRONO_TIME_TRAITS_HPP
Modified: branches/release/boost/asio/detail/completion_handler.hpp
==============================================================================
--- branches/release/boost/asio/detail/completion_handler.hpp (original)
+++ branches/release/boost/asio/detail/completion_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/completion_handler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/config.hpp
==============================================================================
--- branches/release/boost/asio/detail/config.hpp (original)
+++ branches/release/boost/asio/detail/config.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/config.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -12,6 +12,7 @@
#define BOOST_ASIO_DETAIL_CONFIG_HPP
#include <boost/config.hpp>
+#include <boost/version.hpp>
// Default to a header-only implementation. The user must specifically request
// separate compilation by defining either BOOST_ASIO_SEPARATE_COMPILATION or
@@ -154,6 +155,27 @@
# endif // defined(__GNUC__)
#endif // !defined(BOOST_ASIO_DISABLE_STD_ATOMIC)
+// Standard library support for chrono. Some standard libraries (such as the
+// libstdc++ shipped with gcc 4.6) provide monotonic_clock as per early C++0x
+// drafts, rather than the eventually standardised name of steady_clock.
+#if !defined(BOOST_ASIO_DISABLE_STD_CHRONO)
+# if defined(__GNUC__)
+# if ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 6)) || (__GNUC__ > 4)
+# if defined(__GXX_EXPERIMENTAL_CXX0X__)
+# define BOOST_ASIO_HAS_STD_CHRONO
+# define BOOST_ASIO_HAS_STD_CHRONO_MONOTONIC_CLOCK
+# endif // defined(__GXX_EXPERIMENTAL_CXX0X__)
+# endif // ((__GNUC__ == 4) && (__GNUC_MINOR__ >= 6)) || (__GNUC__ > 4)
+# endif // defined(__GNUC__)
+#endif // !defined(BOOST_ASIO_DISABLE_STD_CHRONO)
+
+// Boost support for chrono.
+#if !defined(BOOST_ASIO_DISABLE_BOOST_CHRONO)
+# if (BOOST_VERSION >= 104700)
+# define BOOST_ASIO_HAS_BOOST_CHRONO
+# endif // (BOOST_VERSION >= 104700)
+#endif // !defined(BOOST_ASIO_DISABLE_BOOST_CHRONO)
+
// Windows: target OS version.
#if defined(BOOST_WINDOWS) || defined(__CYGWIN__)
# if !defined(_WIN32_WINNT) && !defined(_WIN32_WINDOWS)
@@ -289,6 +311,15 @@
# endif // defined(BOOST_ASIO_HAS_IOCP)
#endif // !defined(BOOST_ASIO_DISABLE_WINDOWS_RANDOM_ACCESS_HANDLE)
+// Windows: object handles.
+#if !defined(BOOST_ASIO_DISABLE_WINDOWS_OBJECT_HANDLE)
+# if defined(BOOST_WINDOWS) || defined(__CYGWIN__)
+# if !defined(UNDER_CE)
+# define BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE 1
+# endif // !defined(UNDER_CE)
+# endif // defined(BOOST_WINDOWS) || defined(__CYGWIN__)
+#endif // !defined(BOOST_ASIO_DISABLE_WINDOWS_OBJECT_HANDLE)
+
// Windows: OVERLAPPED wrapper.
#if !defined(BOOST_ASIO_DISABLE_WINDOWS_OVERLAPPED_PTR)
# if defined(BOOST_ASIO_HAS_IOCP)
Modified: branches/release/boost/asio/detail/consuming_buffers.hpp
==============================================================================
--- branches/release/boost/asio/detail/consuming_buffers.hpp (original)
+++ branches/release/boost/asio/detail/consuming_buffers.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/consuming_buffers.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/date_time_fwd.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/date_time_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,34 @@
+//
+// detail/date_time_fwd.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_DETAIL_DATE_TIME_FWD_HPP
+#define BOOST_ASIO_DETAIL_DATE_TIME_FWD_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+namespace boost {
+namespace date_time {
+
+template<class T, class TimeSystem>
+class base_time;
+
+} // namespace date_time
+namespace posix_time {
+
+class ptime;
+
+} // namespace posix_time
+} // namespace boost
+
+#endif // BOOST_ASIO_DETAIL_DATE_TIME_FWD_HPP
Modified: branches/release/boost/asio/detail/deadline_timer_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/deadline_timer_service.hpp (original)
+++ branches/release/boost/asio/detail/deadline_timer_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/deadline_timer_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -24,14 +24,10 @@
#include <boost/asio/detail/noncopyable.hpp>
#include <boost/asio/detail/socket_ops.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue.hpp>
#include <boost/asio/detail/timer_scheduler.hpp>
#include <boost/asio/detail/wait_handler.hpp>
-
-#include <boost/asio/detail/push_options.hpp>
-#include <boost/date_time/posix_time/posix_time_types.hpp>
-#include <boost/asio/detail/pop_options.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -166,12 +162,8 @@
ec = boost::system::error_code();
while (Time_Traits::less_than(now, impl.expiry) && !ec)
{
- boost::posix_time::time_duration timeout =
- Time_Traits::to_posix_duration(Time_Traits::subtract(impl.expiry, now));
- ::timeval tv;
- tv.tv_sec = timeout.total_seconds();
- tv.tv_usec = timeout.total_microseconds() % 1000000;
- socket_ops::select(0, 0, 0, 0, &tv, ec);
+ this->do_wait(Time_Traits::to_posix_duration(
+ Time_Traits::subtract(impl.expiry, now)), ec);
now = Time_Traits::now();
}
}
@@ -196,6 +188,18 @@
}
private:
+ // Helper function to wait given a duration type. The duration type should
+ // either be of type boost::posix_time::time_duration, or implement the
+ // required subset of its interface.
+ template <typename Duration>
+ void do_wait(const Duration& timeout, boost::system::error_code& ec)
+ {
+ ::timeval tv;
+ tv.tv_sec = timeout.total_seconds();
+ tv.tv_usec = timeout.total_microseconds() % 1000000;
+ socket_ops::select(0, 0, 0, 0, &tv, ec);
+ }
+
// The queue of timers.
timer_queue<Time_Traits> timer_queue_;
Modified: branches/release/boost/asio/detail/dependent_type.hpp
==============================================================================
--- branches/release/boost/asio/detail/dependent_type.hpp (original)
+++ branches/release/boost/asio/detail/dependent_type.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/dependent_type.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/descriptor_ops.hpp
==============================================================================
--- branches/release/boost/asio/detail/descriptor_ops.hpp (original)
+++ branches/release/boost/asio/detail/descriptor_ops.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/descriptor_ops.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/descriptor_read_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/descriptor_read_op.hpp (original)
+++ branches/release/boost/asio/detail/descriptor_read_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/descriptor_read_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/descriptor_write_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/descriptor_write_op.hpp (original)
+++ branches/release/boost/asio/detail/descriptor_write_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/descriptor_write_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/dev_poll_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/dev_poll_reactor.hpp (original)
+++ branches/release/boost/asio/detail/dev_poll_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/dev_poll_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -31,10 +31,10 @@
#include <boost/asio/detail/reactor_op_queue.hpp>
#include <boost/asio/detail/select_interrupter.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
#include <boost/asio/detail/timer_queue_fwd.hpp>
#include <boost/asio/detail/timer_queue_set.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/io_service.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -125,7 +125,7 @@
template <typename Time_Traits>
void schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op);
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
// Cancel the timer operations associated with the given token. Returns the
// number of operations that have been posted or dispatched.
Modified: branches/release/boost/asio/detail/dev_poll_reactor_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/dev_poll_reactor_fwd.hpp (original)
+++ branches/release/boost/asio/detail/dev_poll_reactor_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/dev_poll_reactor_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/epoll_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/epoll_reactor.hpp (original)
+++ branches/release/boost/asio/detail/epoll_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/epoll_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -29,10 +29,10 @@
#include <boost/asio/detail/reactor_op.hpp>
#include <boost/asio/detail/select_interrupter.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
#include <boost/asio/detail/timer_queue_fwd.hpp>
#include <boost/asio/detail/timer_queue_set.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -147,7 +147,7 @@
template <typename Time_Traits>
void schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op);
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
// Cancel the timer operations associated with the given token. Returns the
// number of operations that have been posted or dispatched.
Modified: branches/release/boost/asio/detail/epoll_reactor_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/epoll_reactor_fwd.hpp (original)
+++ branches/release/boost/asio/detail/epoll_reactor_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/epoll_reactor_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/event.hpp
==============================================================================
--- branches/release/boost/asio/detail/event.hpp (original)
+++ branches/release/boost/asio/detail/event.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/event.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/eventfd_select_interrupter.hpp
==============================================================================
--- branches/release/boost/asio/detail/eventfd_select_interrupter.hpp (original)
+++ branches/release/boost/asio/detail/eventfd_select_interrupter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/eventfd_select_interrupter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Roelof Naude (roelof.naude at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/fd_set_adapter.hpp
==============================================================================
--- branches/release/boost/asio/detail/fd_set_adapter.hpp (original)
+++ branches/release/boost/asio/detail/fd_set_adapter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/fd_set_adapter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/gcc_arm_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/gcc_arm_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/gcc_arm_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/gcc_arm_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/gcc_hppa_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/gcc_hppa_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/gcc_hppa_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/gcc_hppa_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/gcc_sync_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/gcc_sync_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/gcc_sync_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/gcc_sync_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/gcc_x86_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/gcc_x86_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/gcc_x86_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/gcc_x86_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/handler_alloc_helpers.hpp
==============================================================================
--- branches/release/boost/asio/detail/handler_alloc_helpers.hpp (original)
+++ branches/release/boost/asio/detail/handler_alloc_helpers.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/handler_alloc_helpers.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/handler_invoke_helpers.hpp
==============================================================================
--- branches/release/boost/asio/detail/handler_invoke_helpers.hpp (original)
+++ branches/release/boost/asio/detail/handler_invoke_helpers.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/handler_invoke_helpers.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/handler_tracking.hpp
==============================================================================
--- branches/release/boost/asio/detail/handler_tracking.hpp (original)
+++ branches/release/boost/asio/detail/handler_tracking.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/handler_tracking.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/handler_type_requirements.hpp
==============================================================================
--- branches/release/boost/asio/detail/handler_type_requirements.hpp (original)
+++ branches/release/boost/asio/detail/handler_type_requirements.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/handler_type_requirements.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/hash_map.hpp
==============================================================================
--- branches/release/boost/asio/detail/hash_map.hpp (original)
+++ branches/release/boost/asio/detail/hash_map.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/hash_map.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/descriptor_ops.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/descriptor_ops.ipp (original)
+++ branches/release/boost/asio/detail/impl/descriptor_ops.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/descriptor_ops.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/dev_poll_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/dev_poll_reactor.hpp (original)
+++ branches/release/boost/asio/detail/impl/dev_poll_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/dev_poll_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -40,7 +40,7 @@
template <typename Time_Traits>
void dev_poll_reactor::schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op)
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op)
{
boost::asio::detail::mutex::scoped_lock lock(mutex_);
Modified: branches/release/boost/asio/detail/impl/dev_poll_reactor.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/dev_poll_reactor.ipp (original)
+++ branches/release/boost/asio/detail/impl/dev_poll_reactor.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/dev_poll_reactor.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/epoll_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/epoll_reactor.hpp (original)
+++ branches/release/boost/asio/detail/impl/epoll_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/epoll_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -38,7 +38,7 @@
template <typename Time_Traits>
void epoll_reactor::schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op)
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op)
{
mutex::scoped_lock lock(mutex_);
Modified: branches/release/boost/asio/detail/impl/epoll_reactor.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/epoll_reactor.ipp (original)
+++ branches/release/boost/asio/detail/impl/epoll_reactor.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/epoll_reactor.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/eventfd_select_interrupter.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/eventfd_select_interrupter.ipp (original)
+++ branches/release/boost/asio/detail/impl/eventfd_select_interrupter.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/eventfd_select_interrupter.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Roelof Naude (roelof.naude at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/impl/handler_tracking.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/handler_tracking.ipp (original)
+++ branches/release/boost/asio/detail/impl/handler_tracking.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/handler_tracking.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/kqueue_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/kqueue_reactor.hpp (original)
+++ branches/release/boost/asio/detail/impl/kqueue_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/kqueue_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2005 Stefan Arentz (stefan at soze dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
@@ -42,7 +42,7 @@
template <typename Time_Traits>
void kqueue_reactor::schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op)
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op)
{
boost::asio::detail::mutex::scoped_lock lock(mutex_);
Modified: branches/release/boost/asio/detail/impl/kqueue_reactor.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/kqueue_reactor.ipp (original)
+++ branches/release/boost/asio/detail/impl/kqueue_reactor.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/kqueue_reactor.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2005 Stefan Arentz (stefan at soze dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
@@ -28,8 +28,8 @@
#if defined(__NetBSD__)
# define BOOST_ASIO_KQUEUE_EV_SET(ev, ident, filt, flags, fflags, data, udata) \
- EV_SET(ev, ident, filt, flags, fflags, \
- data, reinterpret_cast<intptr_t>(udata))
+ EV_SET(ev, ident, filt, flags, fflags, data, \
+ reinterpret_cast<intptr_t>(static_cast<void*>(udata)))
#else
# define BOOST_ASIO_KQUEUE_EV_SET(ev, ident, filt, flags, fflags, data, udata) \
EV_SET(ev, ident, filt, flags, fflags, data, udata)
Modified: branches/release/boost/asio/detail/impl/pipe_select_interrupter.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/pipe_select_interrupter.ipp (original)
+++ branches/release/boost/asio/detail/impl/pipe_select_interrupter.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/pipe_select_interrupter.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/posix_event.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/posix_event.ipp (original)
+++ branches/release/boost/asio/detail/impl/posix_event.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/posix_event.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/posix_mutex.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/posix_mutex.ipp (original)
+++ branches/release/boost/asio/detail/impl/posix_mutex.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/posix_mutex.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/posix_thread.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/posix_thread.ipp (original)
+++ branches/release/boost/asio/detail/impl/posix_thread.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/posix_thread.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/posix_tss_ptr.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/posix_tss_ptr.ipp (original)
+++ branches/release/boost/asio/detail/impl/posix_tss_ptr.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/posix_tss_ptr.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/reactive_descriptor_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/reactive_descriptor_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/reactive_descriptor_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/reactive_descriptor_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/reactive_serial_port_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/reactive_serial_port_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/reactive_serial_port_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/reactive_serial_port_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/impl/reactive_socket_service_base.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/reactive_socket_service_base.ipp (original)
+++ branches/release/boost/asio/detail/impl/reactive_socket_service_base.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_service_base.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/resolver_service_base.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/resolver_service_base.ipp (original)
+++ branches/release/boost/asio/detail/impl/resolver_service_base.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/resolver_service_base.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/select_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/select_reactor.hpp (original)
+++ branches/release/boost/asio/detail/impl/select_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/select_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -44,7 +44,7 @@
template <typename Time_Traits>
void select_reactor::schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op)
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op)
{
boost::asio::detail::mutex::scoped_lock lock(mutex_);
Modified: branches/release/boost/asio/detail/impl/select_reactor.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/select_reactor.ipp (original)
+++ branches/release/boost/asio/detail/impl/select_reactor.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/select_reactor.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/service_registry.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/service_registry.hpp (original)
+++ branches/release/boost/asio/detail/impl/service_registry.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/service_registry.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/service_registry.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/service_registry.ipp (original)
+++ branches/release/boost/asio/detail/impl/service_registry.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/service_registry.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/signal_set_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/signal_set_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/signal_set_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/signal_set_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/socket_ops.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/socket_ops.ipp (original)
+++ branches/release/boost/asio/detail/impl/socket_ops.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/socket_ops.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -465,6 +465,10 @@
&msghdr::msg_namelen, s, addr, addrlen), ec);
if (result == 0)
ec = boost::system::error_code();
+#if defined(__linux__)
+ else if (ec == boost::asio::error::try_again)
+ ec = boost::asio::error::no_buffer_space;
+#endif // defined(__linux__)
return result;
}
Modified: branches/release/boost/asio/detail/impl/socket_select_interrupter.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/socket_select_interrupter.ipp (original)
+++ branches/release/boost/asio/detail/impl/socket_select_interrupter.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/socket_select_interrupter.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/strand_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/strand_service.hpp (original)
+++ branches/release/boost/asio/detail/impl/strand_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/strand_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/strand_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/strand_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/strand_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/strand_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/task_io_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/task_io_service.hpp (original)
+++ branches/release/boost/asio/detail/impl/task_io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/task_io_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/task_io_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/task_io_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/task_io_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/task_io_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -336,7 +336,10 @@
task_interrupted_ = more_handlers;
if (more_handlers && !one_thread_)
- wake_one_idle_thread_and_unlock(lock);
+ {
+ if (!wake_one_idle_thread_and_unlock(lock))
+ lock.unlock();
+ }
else
lock.unlock();
Modified: branches/release/boost/asio/detail/impl/throw_error.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/throw_error.ipp (original)
+++ branches/release/boost/asio/detail/impl/throw_error.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/throw_error.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/impl/timer_queue_ptime.ipp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/impl/timer_queue_ptime.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,82 @@
+//
+// detail/impl/timer_queue_ptime.ipp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_DETAIL_IMPL_TIMER_QUEUE_PTIME_IPP
+#define BOOST_ASIO_DETAIL_IMPL_TIMER_QUEUE_PTIME_IPP
+
+#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/detail/timer_queue_ptime.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+timer_queue<time_traits<boost::posix_time::ptime> >::timer_queue()
+{
+}
+
+timer_queue<time_traits<boost::posix_time::ptime> >::~timer_queue()
+{
+}
+
+bool timer_queue<time_traits<boost::posix_time::ptime> >::enqueue_timer(
+ const time_type& time, per_timer_data& timer, wait_op* op)
+{
+ return impl_.enqueue_timer(time, timer, op);
+}
+
+bool timer_queue<time_traits<boost::posix_time::ptime> >::empty() const
+{
+ return impl_.empty();
+}
+
+long timer_queue<time_traits<boost::posix_time::ptime> >::wait_duration_msec(
+ long max_duration) const
+{
+ return impl_.wait_duration_msec(max_duration);
+}
+
+long timer_queue<time_traits<boost::posix_time::ptime> >::wait_duration_usec(
+ long max_duration) const
+{
+ return impl_.wait_duration_usec(max_duration);
+}
+
+void timer_queue<time_traits<boost::posix_time::ptime> >::get_ready_timers(
+ op_queue<operation>& ops)
+{
+ impl_.get_ready_timers(ops);
+}
+
+void timer_queue<time_traits<boost::posix_time::ptime> >::get_all_timers(
+ op_queue<operation>& ops)
+{
+ impl_.get_all_timers(ops);
+}
+
+std::size_t timer_queue<time_traits<boost::posix_time::ptime> >::cancel_timer(
+ per_timer_data& timer, op_queue<operation>& ops, std::size_t max_cancelled)
+{
+ return impl_.cancel_timer(timer, ops, max_cancelled);
+}
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_DETAIL_IMPL_TIMER_QUEUE_PTIME_IPP
Modified: branches/release/boost/asio/detail/impl/timer_queue_set.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/timer_queue_set.ipp (original)
+++ branches/release/boost/asio/detail/impl/timer_queue_set.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/timer_queue_set.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/win_event.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_event.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_event.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_event.ipp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/win_iocp_handle_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_iocp_handle_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_iocp_handle_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_iocp_handle_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/impl/win_iocp_io_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_iocp_io_service.hpp (original)
+++ branches/release/boost/asio/detail/impl/win_iocp_io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_iocp_io_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -87,7 +87,7 @@
template <typename Time_Traits>
void win_iocp_io_service::schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op)
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op)
{
// If the service has been shut down we silently discard the timer.
if (::InterlockedExchangeAdd(&shutdown_, 0) != 0)
Modified: branches/release/boost/asio/detail/impl/win_iocp_io_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_iocp_io_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_iocp_io_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_iocp_io_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -148,7 +148,7 @@
{
if (::InterlockedExchangeAdd(&outstanding_work_, 0) == 0)
{
- stop();
+ InterlockedExchange(&stopped_, 1);
ec = boost::system::error_code();
return 0;
}
@@ -166,7 +166,7 @@
{
if (::InterlockedExchangeAdd(&outstanding_work_, 0) == 0)
{
- stop();
+ InterlockedExchange(&stopped_, 1);
ec = boost::system::error_code();
return 0;
}
@@ -180,7 +180,7 @@
{
if (::InterlockedExchangeAdd(&outstanding_work_, 0) == 0)
{
- stop();
+ InterlockedExchange(&stopped_, 1);
ec = boost::system::error_code();
return 0;
}
@@ -198,7 +198,7 @@
{
if (::InterlockedExchangeAdd(&outstanding_work_, 0) == 0)
{
- stop();
+ InterlockedExchange(&stopped_, 1);
ec = boost::system::error_code();
return 0;
}
Modified: branches/release/boost/asio/detail/impl/win_iocp_serial_port_service.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_iocp_serial_port_service.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_iocp_serial_port_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_iocp_serial_port_service.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/impl/win_iocp_socket_service_base.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_iocp_socket_service_base.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_iocp_socket_service_base.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_iocp_socket_service_base.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/win_mutex.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_mutex.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_mutex.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_mutex.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/impl/win_object_handle_service.ipp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/impl/win_object_handle_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,446 @@
+//
+// detail/impl/win_object_handle_service.ipp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2011 Boris Schaeling (boris_at_[hidden])
+//
+// 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_DETAIL_IMPL_WIN_OBJECT_HANDLE_SERVICE_IPP
+#define BOOST_ASIO_DETAIL_IMPL_WIN_OBJECT_HANDLE_SERVICE_IPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+
+#include <boost/asio/detail/win_object_handle_service.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+win_object_handle_service::win_object_handle_service(
+ boost::asio::io_service& io_service)
+ : io_service_(boost::asio::use_service<io_service_impl>(io_service)),
+ mutex_(),
+ impl_list_(0),
+ shutdown_(false)
+{
+}
+
+void win_object_handle_service::shutdown_service()
+{
+ mutex::scoped_lock lock(mutex_);
+
+ // Setting this flag to true prevents new objects from being registered, and
+ // new asynchronous wait operations from being started. We only need to worry
+ // about cleaning up the operations that are currently in progress.
+ shutdown_ = true;
+
+ op_queue<operation> ops;
+ for (implementation_type* impl = impl_list_; impl; impl = impl->next_)
+ ops.push(impl->op_queue_);
+
+ lock.unlock();
+
+ io_service_.abandon_operations(ops);
+}
+
+void win_object_handle_service::construct(
+ win_object_handle_service::implementation_type& impl)
+{
+ impl.handle_ = INVALID_HANDLE_VALUE;
+ impl.wait_handle_ = INVALID_HANDLE_VALUE;
+ impl.owner_ = this;
+
+ // Insert implementation into linked list of all implementations.
+ mutex::scoped_lock lock(mutex_);
+ if (!shutdown_)
+ {
+ impl.next_ = impl_list_;
+ impl.prev_ = 0;
+ if (impl_list_)
+ impl_list_->prev_ = &impl;
+ impl_list_ = &impl;
+ }
+}
+
+void win_object_handle_service::move_construct(
+ win_object_handle_service::implementation_type& impl,
+ win_object_handle_service::implementation_type& other_impl)
+{
+ mutex::scoped_lock lock(mutex_);
+
+ // Insert implementation into linked list of all implementations.
+ if (!shutdown_)
+ {
+ impl.next_ = impl_list_;
+ impl.prev_ = 0;
+ if (impl_list_)
+ impl_list_->prev_ = &impl;
+ impl_list_ = &impl;
+ }
+
+ impl.handle_ = other_impl.handle_;
+ other_impl.handle_ = INVALID_HANDLE_VALUE;
+ impl.wait_handle_ = other_impl.wait_handle_;
+ other_impl.wait_handle_ = INVALID_HANDLE_VALUE;
+ impl.op_queue_.push(other_impl.op_queue_);
+ impl.owner_ = this;
+
+ // We must not hold the lock while calling UnregisterWaitEx. This is because
+ // the registered callback function might be invoked while we are waiting for
+ // UnregisterWaitEx to complete.
+ lock.unlock();
+
+ if (impl.wait_handle_ != INVALID_HANDLE_VALUE)
+ ::UnregisterWaitEx(impl.wait_handle_, INVALID_HANDLE_VALUE);
+
+ if (!impl.op_queue_.empty())
+ register_wait_callback(impl, lock);
+}
+
+void win_object_handle_service::move_assign(
+ win_object_handle_service::implementation_type& impl,
+ win_object_handle_service& other_service,
+ win_object_handle_service::implementation_type& other_impl)
+{
+ boost::system::error_code ignored_ec;
+ close(impl, ignored_ec);
+
+ mutex::scoped_lock lock(mutex_);
+
+ if (this != &other_service)
+ {
+ // Remove implementation from linked list of all implementations.
+ if (impl_list_ == &impl)
+ impl_list_ = impl.next_;
+ if (impl.prev_)
+ impl.prev_->next_ = impl.next_;
+ if (impl.next_)
+ impl.next_->prev_= impl.prev_;
+ impl.next_ = 0;
+ impl.prev_ = 0;
+ }
+
+ impl.handle_ = other_impl.handle_;
+ other_impl.handle_ = INVALID_HANDLE_VALUE;
+ impl.wait_handle_ = other_impl.wait_handle_;
+ other_impl.wait_handle_ = INVALID_HANDLE_VALUE;
+ impl.op_queue_.push(other_impl.op_queue_);
+ impl.owner_ = this;
+
+ if (this != &other_service)
+ {
+ // Insert implementation into linked list of all implementations.
+ impl.next_ = other_service.impl_list_;
+ impl.prev_ = 0;
+ if (other_service.impl_list_)
+ other_service.impl_list_->prev_ = &impl;
+ other_service.impl_list_ = &impl;
+ }
+
+ // We must not hold the lock while calling UnregisterWaitEx. This is because
+ // the registered callback function might be invoked while we are waiting for
+ // UnregisterWaitEx to complete.
+ lock.unlock();
+
+ if (impl.wait_handle_ != INVALID_HANDLE_VALUE)
+ ::UnregisterWaitEx(impl.wait_handle_, INVALID_HANDLE_VALUE);
+
+ if (!impl.op_queue_.empty())
+ register_wait_callback(impl, lock);
+}
+
+void win_object_handle_service::destroy(
+ win_object_handle_service::implementation_type& impl)
+{
+ mutex::scoped_lock lock(mutex_);
+
+ // Remove implementation from linked list of all implementations.
+ if (impl_list_ == &impl)
+ impl_list_ = impl.next_;
+ if (impl.prev_)
+ impl.prev_->next_ = impl.next_;
+ if (impl.next_)
+ impl.next_->prev_= impl.prev_;
+ impl.next_ = 0;
+ impl.prev_ = 0;
+
+ if (is_open(impl))
+ {
+ BOOST_ASIO_HANDLER_OPERATION(("object_handle", &impl, "close"));
+
+ HANDLE wait_handle = impl.wait_handle_;
+ impl.wait_handle_ = INVALID_HANDLE_VALUE;
+
+ op_queue<operation> ops;
+ while (wait_op* op = impl.op_queue_.front())
+ {
+ op->ec_ = boost::asio::error::operation_aborted;
+ impl.op_queue_.pop();
+ ops.push(op);
+ }
+
+ // We must not hold the lock while calling UnregisterWaitEx. This is
+ // because the registered callback function might be invoked while we are
+ // waiting for UnregisterWaitEx to complete.
+ lock.unlock();
+
+ if (wait_handle != INVALID_HANDLE_VALUE)
+ ::UnregisterWaitEx(wait_handle, INVALID_HANDLE_VALUE);
+
+ ::CloseHandle(impl.handle_);
+ impl.handle_ = INVALID_HANDLE_VALUE;
+
+ io_service_.post_deferred_completions(ops);
+ }
+}
+
+boost::system::error_code win_object_handle_service::assign(
+ win_object_handle_service::implementation_type& impl,
+ const native_handle_type& handle, boost::system::error_code& ec)
+{
+ if (is_open(impl))
+ {
+ ec = boost::asio::error::already_open;
+ return ec;
+ }
+
+ impl.handle_ = handle;
+ ec = boost::system::error_code();
+ return ec;
+}
+
+boost::system::error_code win_object_handle_service::close(
+ win_object_handle_service::implementation_type& impl,
+ boost::system::error_code& ec)
+{
+ if (is_open(impl))
+ {
+ BOOST_ASIO_HANDLER_OPERATION(("object_handle", &impl, "close"));
+
+ mutex::scoped_lock lock(mutex_);
+
+ HANDLE wait_handle = impl.wait_handle_;
+ impl.wait_handle_ = INVALID_HANDLE_VALUE;
+
+ op_queue<operation> completed_ops;
+ while (wait_op* op = impl.op_queue_.front())
+ {
+ impl.op_queue_.pop();
+ op->ec_ = boost::asio::error::operation_aborted;
+ completed_ops.push(op);
+ }
+
+ // We must not hold the lock while calling UnregisterWaitEx. This is
+ // because the registered callback function might be invoked while we are
+ // waiting for UnregisterWaitEx to complete.
+ lock.unlock();
+
+ if (wait_handle != INVALID_HANDLE_VALUE)
+ ::UnregisterWaitEx(wait_handle, INVALID_HANDLE_VALUE);
+
+ if (::CloseHandle(impl.handle_))
+ {
+ impl.handle_ = INVALID_HANDLE_VALUE;
+ ec = boost::system::error_code();
+ }
+ else
+ {
+ DWORD last_error = ::GetLastError();
+ ec = boost::system::error_code(last_error,
+ boost::asio::error::get_system_category());
+ }
+
+ io_service_.post_deferred_completions(completed_ops);
+ }
+ else
+ {
+ ec = boost::system::error_code();
+ }
+
+ return ec;
+}
+
+boost::system::error_code win_object_handle_service::cancel(
+ win_object_handle_service::implementation_type& impl,
+ boost::system::error_code& ec)
+{
+ if (is_open(impl))
+ {
+ BOOST_ASIO_HANDLER_OPERATION(("object_handle", &impl, "cancel"));
+
+ mutex::scoped_lock lock(mutex_);
+
+ HANDLE wait_handle = impl.wait_handle_;
+ impl.wait_handle_ = INVALID_HANDLE_VALUE;
+
+ op_queue<operation> completed_ops;
+ while (wait_op* op = impl.op_queue_.front())
+ {
+ op->ec_ = boost::asio::error::operation_aborted;
+ impl.op_queue_.pop();
+ completed_ops.push(op);
+ }
+
+ // We must not hold the lock while calling UnregisterWaitEx. This is
+ // because the registered callback function might be invoked while we are
+ // waiting for UnregisterWaitEx to complete.
+ lock.unlock();
+
+ if (wait_handle != INVALID_HANDLE_VALUE)
+ ::UnregisterWaitEx(wait_handle, INVALID_HANDLE_VALUE);
+
+ ec = boost::system::error_code();
+
+ io_service_.post_deferred_completions(completed_ops);
+ }
+ else
+ {
+ ec = boost::asio::error::bad_descriptor;
+ }
+
+ return ec;
+}
+
+void win_object_handle_service::wait(
+ win_object_handle_service::implementation_type& impl,
+ boost::system::error_code& ec)
+{
+ switch (::WaitForSingleObject(impl.handle_, INFINITE))
+ {
+ case WAIT_FAILED:
+ {
+ DWORD last_error = ::GetLastError();
+ ec = boost::system::error_code(last_error,
+ boost::asio::error::get_system_category());
+ break;
+ }
+ case WAIT_OBJECT_0:
+ case WAIT_ABANDONED:
+ default:
+ ec = boost::system::error_code();
+ break;
+ }
+}
+
+void win_object_handle_service::start_wait_op(
+ win_object_handle_service::implementation_type& impl, wait_op* op)
+{
+ io_service_.work_started();
+
+ if (is_open(impl))
+ {
+ mutex::scoped_lock lock(mutex_);
+
+ if (!shutdown_)
+ {
+ impl.op_queue_.push(op);
+
+ // Only the first operation to be queued gets to register a wait callback.
+ // Subsequent operations have to wait for the first to finish.
+ if (impl.op_queue_.front() == op)
+ register_wait_callback(impl, lock);
+ }
+ else
+ {
+ lock.unlock();
+ io_service_.post_deferred_completion(op);
+ }
+ }
+ else
+ {
+ op->ec_ = boost::asio::error::bad_descriptor;
+ io_service_.post_deferred_completion(op);
+ }
+}
+
+void win_object_handle_service::register_wait_callback(
+ win_object_handle_service::implementation_type& impl,
+ mutex::scoped_lock& lock)
+{
+ lock.lock();
+
+ if (!RegisterWaitForSingleObject(&impl.wait_handle_,
+ impl.handle_, &win_object_handle_service::wait_callback,
+ &impl, INFINITE, WT_EXECUTEONLYONCE))
+ {
+ DWORD last_error = ::GetLastError();
+ boost::system::error_code ec(last_error,
+ boost::asio::error::get_system_category());
+
+ op_queue<operation> completed_ops;
+ while (wait_op* op = impl.op_queue_.front())
+ {
+ op->ec_ = ec;
+ impl.op_queue_.pop();
+ completed_ops.push(op);
+ }
+
+ lock.unlock();
+ io_service_.post_deferred_completions(completed_ops);
+ }
+}
+
+void win_object_handle_service::wait_callback(PVOID param, BOOLEAN)
+{
+ implementation_type* impl = static_cast<implementation_type*>(param);
+ mutex::scoped_lock lock(impl->owner_->mutex_);
+
+ if (impl->wait_handle_ != INVALID_HANDLE_VALUE)
+ {
+ ::UnregisterWaitEx(impl->wait_handle_, NULL);
+ impl->wait_handle_ = INVALID_HANDLE_VALUE;
+ }
+
+ if (wait_op* op = impl->op_queue_.front())
+ {
+ op_queue<operation> completed_ops;
+
+ op->ec_ = boost::system::error_code();
+ impl->op_queue_.pop();
+ completed_ops.push(op);
+
+ if (!impl->op_queue_.empty())
+ {
+ if (!RegisterWaitForSingleObject(&impl->wait_handle_,
+ impl->handle_, &win_object_handle_service::wait_callback,
+ param, INFINITE, WT_EXECUTEONLYONCE))
+ {
+ DWORD last_error = ::GetLastError();
+ boost::system::error_code ec(last_error,
+ boost::asio::error::get_system_category());
+
+ while (wait_op* op = impl->op_queue_.front())
+ {
+ op->ec_ = ec;
+ impl->op_queue_.pop();
+ completed_ops.push(op);
+ }
+ }
+ }
+
+ lock.unlock();
+ impl->owner_->io_service_.post_deferred_completions(completed_ops);
+ }
+}
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+
+#endif // BOOST_ASIO_DETAIL_IMPL_WIN_OBJECT_HANDLE_SERVICE_IPP
Modified: branches/release/boost/asio/detail/impl/win_static_mutex.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_static_mutex.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_static_mutex.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_static_mutex.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/win_thread.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_thread.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_thread.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_thread.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/win_tss_ptr.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/win_tss_ptr.ipp (original)
+++ branches/release/boost/asio/detail/impl/win_tss_ptr.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/win_tss_ptr.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/impl/winsock_init.ipp
==============================================================================
--- branches/release/boost/asio/detail/impl/winsock_init.ipp (original)
+++ branches/release/boost/asio/detail/impl/winsock_init.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/impl/winsock_init.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/io_control.hpp
==============================================================================
--- branches/release/boost/asio/detail/io_control.hpp (original)
+++ branches/release/boost/asio/detail/io_control.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/io_control.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/kqueue_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/kqueue_reactor.hpp (original)
+++ branches/release/boost/asio/detail/kqueue_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/kqueue_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2005 Stefan Arentz (stefan at soze dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
@@ -32,10 +32,10 @@
#include <boost/asio/detail/reactor_op.hpp>
#include <boost/asio/detail/select_interrupter.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
#include <boost/asio/detail/timer_queue_fwd.hpp>
#include <boost/asio/detail/timer_queue_set.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/error.hpp>
#include <boost/asio/io_service.hpp>
@@ -149,7 +149,7 @@
template <typename Time_Traits>
void schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op);
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
// Cancel the timer operations associated with the given token. Returns the
// number of operations that have been posted or dispatched.
Modified: branches/release/boost/asio/detail/kqueue_reactor_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/kqueue_reactor_fwd.hpp (original)
+++ branches/release/boost/asio/detail/kqueue_reactor_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/kqueue_reactor_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2005 Stefan Arentz (stefan at soze dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/local_free_on_block_exit.hpp
==============================================================================
--- branches/release/boost/asio/detail/local_free_on_block_exit.hpp (original)
+++ branches/release/boost/asio/detail/local_free_on_block_exit.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/local_free_on_block_exit.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/macos_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/macos_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/macos_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/macos_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/mutex.hpp (original)
+++ branches/release/boost/asio/detail/mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/mutex.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/noncopyable.hpp
==============================================================================
--- branches/release/boost/asio/detail/noncopyable.hpp (original)
+++ branches/release/boost/asio/detail/noncopyable.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/noncopyable.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_event.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_event.hpp (original)
+++ branches/release/boost/asio/detail/null_event.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_event.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/null_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_mutex.hpp (original)
+++ branches/release/boost/asio/detail/null_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_signal_blocker.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_signal_blocker.hpp (original)
+++ branches/release/boost/asio/detail/null_signal_blocker.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_signal_blocker.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_static_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_static_mutex.hpp (original)
+++ branches/release/boost/asio/detail/null_static_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_static_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_thread.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_thread.hpp (original)
+++ branches/release/boost/asio/detail/null_thread.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_thread.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/null_tss_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/null_tss_ptr.hpp (original)
+++ branches/release/boost/asio/detail/null_tss_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/null_tss_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/object_pool.hpp
==============================================================================
--- branches/release/boost/asio/detail/object_pool.hpp (original)
+++ branches/release/boost/asio/detail/object_pool.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/object_pool.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/old_win_sdk_compat.hpp
==============================================================================
--- branches/release/boost/asio/detail/old_win_sdk_compat.hpp (original)
+++ branches/release/boost/asio/detail/old_win_sdk_compat.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/old_win_sdk_compat.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/op_queue.hpp
==============================================================================
--- branches/release/boost/asio/detail/op_queue.hpp (original)
+++ branches/release/boost/asio/detail/op_queue.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/op_queue.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/operation.hpp
==============================================================================
--- branches/release/boost/asio/detail/operation.hpp (original)
+++ branches/release/boost/asio/detail/operation.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/operation.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/pipe_select_interrupter.hpp
==============================================================================
--- branches/release/boost/asio/detail/pipe_select_interrupter.hpp (original)
+++ branches/release/boost/asio/detail/pipe_select_interrupter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/pipe_select_interrupter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/pop_options.hpp
==============================================================================
--- branches/release/boost/asio/detail/pop_options.hpp (original)
+++ branches/release/boost/asio/detail/pop_options.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/pop_options.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_event.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_event.hpp (original)
+++ branches/release/boost/asio/detail/posix_event.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_event.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_fd_set_adapter.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_fd_set_adapter.hpp (original)
+++ branches/release/boost/asio/detail/posix_fd_set_adapter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_fd_set_adapter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_mutex.hpp (original)
+++ branches/release/boost/asio/detail/posix_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_signal_blocker.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_signal_blocker.hpp (original)
+++ branches/release/boost/asio/detail/posix_signal_blocker.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_signal_blocker.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_static_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_static_mutex.hpp (original)
+++ branches/release/boost/asio/detail/posix_static_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_static_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_thread.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_thread.hpp (original)
+++ branches/release/boost/asio/detail/posix_thread.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_thread.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/posix_tss_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/posix_tss_ptr.hpp (original)
+++ branches/release/boost/asio/detail/posix_tss_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/posix_tss_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/push_options.hpp
==============================================================================
--- branches/release/boost/asio/detail/push_options.hpp (original)
+++ branches/release/boost/asio/detail/push_options.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/push_options.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_descriptor_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_descriptor_service.hpp (original)
+++ branches/release/boost/asio/detail/reactive_descriptor_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_descriptor_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_null_buffers_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_null_buffers_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_null_buffers_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_null_buffers_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_serial_port_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_serial_port_service.hpp (original)
+++ branches/release/boost/asio/detail/reactive_serial_port_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_serial_port_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/reactive_socket_accept_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_accept_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_accept_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_accept_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_connect_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_connect_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_connect_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_connect_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_recv_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_recv_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_recv_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_recv_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_recvfrom_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_recvfrom_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_recvfrom_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_recvfrom_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_recvmsg_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_recvmsg_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_recvmsg_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_recvmsg_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_send_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_send_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_send_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_send_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_sendto_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_sendto_op.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_sendto_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_sendto_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_service.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactive_socket_service_base.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactive_socket_service_base.hpp (original)
+++ branches/release/boost/asio/detail/reactive_socket_service_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactive_socket_service_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactor.hpp (original)
+++ branches/release/boost/asio/detail/reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactor.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactor_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactor_fwd.hpp (original)
+++ branches/release/boost/asio/detail/reactor_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactor_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactor_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactor_op.hpp (original)
+++ branches/release/boost/asio/detail/reactor_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactor_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/reactor_op_queue.hpp
==============================================================================
--- branches/release/boost/asio/detail/reactor_op_queue.hpp (original)
+++ branches/release/boost/asio/detail/reactor_op_queue.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/reactor_op_queue.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/regex_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/regex_fwd.hpp (original)
+++ branches/release/boost/asio/detail/regex_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/regex_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/resolve_endpoint_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/resolve_endpoint_op.hpp (original)
+++ branches/release/boost/asio/detail/resolve_endpoint_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/resolve_endpoint_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/resolve_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/resolve_op.hpp (original)
+++ branches/release/boost/asio/detail/resolve_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/resolve_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/resolver_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/resolver_service.hpp (original)
+++ branches/release/boost/asio/detail/resolver_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/resolver_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/resolver_service_base.hpp
==============================================================================
--- branches/release/boost/asio/detail/resolver_service_base.hpp (original)
+++ branches/release/boost/asio/detail/resolver_service_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/resolver_service_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/scoped_lock.hpp
==============================================================================
--- branches/release/boost/asio/detail/scoped_lock.hpp (original)
+++ branches/release/boost/asio/detail/scoped_lock.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/scoped_lock.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/scoped_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/scoped_ptr.hpp (original)
+++ branches/release/boost/asio/detail/scoped_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/scoped_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/select_interrupter.hpp
==============================================================================
--- branches/release/boost/asio/detail/select_interrupter.hpp (original)
+++ branches/release/boost/asio/detail/select_interrupter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/select_interrupter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/select_reactor.hpp
==============================================================================
--- branches/release/boost/asio/detail/select_reactor.hpp (original)
+++ branches/release/boost/asio/detail/select_reactor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/select_reactor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -32,10 +32,10 @@
#include <boost/asio/detail/select_interrupter.hpp>
#include <boost/asio/detail/select_reactor_fwd.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
#include <boost/asio/detail/timer_queue_fwd.hpp>
#include <boost/asio/detail/timer_queue_set.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/io_service.hpp>
#if defined(BOOST_ASIO_HAS_IOCP)
@@ -134,7 +134,7 @@
template <typename Time_Traits>
void schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op);
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
// Cancel the timer operations associated with the given token. Returns the
// number of operations that have been posted or dispatched.
Modified: branches/release/boost/asio/detail/select_reactor_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/select_reactor_fwd.hpp (original)
+++ branches/release/boost/asio/detail/select_reactor_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/select_reactor_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/service_registry.hpp
==============================================================================
--- branches/release/boost/asio/detail/service_registry.hpp (original)
+++ branches/release/boost/asio/detail/service_registry.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/service_registry.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/service_registry_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/service_registry_fwd.hpp (original)
+++ branches/release/boost/asio/detail/service_registry_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/service_registry_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/shared_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/shared_ptr.hpp (original)
+++ branches/release/boost/asio/detail/shared_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/shared_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/signal_blocker.hpp
==============================================================================
--- branches/release/boost/asio/detail/signal_blocker.hpp (original)
+++ branches/release/boost/asio/detail/signal_blocker.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/signal_blocker.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/signal_handler.hpp
==============================================================================
--- branches/release/boost/asio/detail/signal_handler.hpp (original)
+++ branches/release/boost/asio/detail/signal_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/signal_handler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/signal_init.hpp
==============================================================================
--- branches/release/boost/asio/detail/signal_init.hpp (original)
+++ branches/release/boost/asio/detail/signal_init.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/signal_init.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/signal_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/signal_op.hpp (original)
+++ branches/release/boost/asio/detail/signal_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/signal_op.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/signal_set_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/signal_set_service.hpp (original)
+++ branches/release/boost/asio/detail/signal_set_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/signal_set_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/socket_holder.hpp
==============================================================================
--- branches/release/boost/asio/detail/socket_holder.hpp (original)
+++ branches/release/boost/asio/detail/socket_holder.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_holder.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/socket_ops.hpp
==============================================================================
--- branches/release/boost/asio/detail/socket_ops.hpp (original)
+++ branches/release/boost/asio/detail/socket_ops.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_ops.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/socket_option.hpp
==============================================================================
--- branches/release/boost/asio/detail/socket_option.hpp (original)
+++ branches/release/boost/asio/detail/socket_option.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_option.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/socket_select_interrupter.hpp
==============================================================================
--- branches/release/boost/asio/detail/socket_select_interrupter.hpp (original)
+++ branches/release/boost/asio/detail/socket_select_interrupter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_select_interrupter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/socket_types.hpp
==============================================================================
--- branches/release/boost/asio/detail/socket_types.hpp (original)
+++ branches/release/boost/asio/detail/socket_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_types.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/solaris_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/solaris_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/solaris_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/solaris_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/static_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/static_mutex.hpp (original)
+++ branches/release/boost/asio/detail/static_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/static_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/strand_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/strand_service.hpp (original)
+++ branches/release/boost/asio/detail/strand_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/strand_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/task_io_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/task_io_service.hpp (original)
+++ branches/release/boost/asio/detail/task_io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/task_io_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -89,7 +89,7 @@
// Return whether a handler can be dispatched immediately.
bool can_dispatch()
{
- return thread_call_stack::contains(this);
+ return thread_call_stack::contains(this) != 0;
}
// Request invocation of the given handler.
Modified: branches/release/boost/asio/detail/task_io_service_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/task_io_service_fwd.hpp (original)
+++ branches/release/boost/asio/detail/task_io_service_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/task_io_service_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/task_io_service_operation.hpp
==============================================================================
--- branches/release/boost/asio/detail/task_io_service_operation.hpp (original)
+++ branches/release/boost/asio/detail/task_io_service_operation.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/task_io_service_operation.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/thread.hpp
==============================================================================
--- branches/release/boost/asio/detail/thread.hpp (original)
+++ branches/release/boost/asio/detail/thread.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/thread.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/throw_error.hpp
==============================================================================
--- branches/release/boost/asio/detail/throw_error.hpp (original)
+++ branches/release/boost/asio/detail/throw_error.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/throw_error.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Deleted: branches/release/boost/asio/detail/timer_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
+++ (empty file)
@@ -1,47 +0,0 @@
-//
-// detail/timer_op.hpp
-// ~~~~~~~~~~~~~~~~~~~
-//
-// Copyright (c) 2003-2011 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_DETAIL_TIMER_OP_HPP
-#define BOOST_ASIO_DETAIL_TIMER_OP_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/detail/operation.hpp>
-
-#include <boost/asio/detail/push_options.hpp>
-
-namespace boost {
-namespace asio {
-namespace detail {
-
-class timer_op
- : public operation
-{
-public:
- // The error code to be passed to the completion handler.
- boost::system::error_code ec_;
-
-protected:
- timer_op(func_type func)
- : operation(func)
- {
- }
-};
-
-} // namespace detail
-} // namespace asio
-} // namespace boost
-
-#include <boost/asio/detail/pop_options.hpp>
-
-#endif // BOOST_ASIO_DETAIL_TIMER_OP_HPP
Modified: branches/release/boost/asio/detail/timer_queue.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_queue.hpp (original)
+++ branches/release/boost/asio/detail/timer_queue.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_queue.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -20,15 +20,12 @@
#include <vector>
#include <boost/config.hpp>
#include <boost/limits.hpp>
+#include <boost/cstdint.hpp>
+#include <boost/asio/detail/date_time_fwd.hpp>
#include <boost/asio/detail/op_queue.hpp>
-#include <boost/asio/detail/timer_op.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/error.hpp>
-#include <boost/asio/time_traits.hpp>
-
-#include <boost/asio/detail/push_options.hpp>
-#include <boost/date_time/posix_time/posix_time_types.hpp>
-#include <boost/asio/detail/pop_options.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -57,7 +54,7 @@
friend class timer_queue;
// The operations waiting on the timer.
- op_queue<timer_op> op_queue_;
+ op_queue<wait_op> op_queue_;
// The index of the timer in the heap.
std::size_t heap_index_;
@@ -77,7 +74,7 @@
// Add a new timer to the queue. Returns true if this is the timer that is
// earliest in the queue, in which case the reactor's event demultiplexing
// function call may need to be interrupted and restarted.
- bool enqueue_timer(const time_type& time, per_timer_data& timer, timer_op* op)
+ bool enqueue_timer(const time_type& time, per_timer_data& timer, wait_op* op)
{
// Enqueue the timer object.
if (timer.prev_ == 0 && &timer != timers_)
@@ -124,17 +121,10 @@
if (heap_.empty())
return max_duration;
- boost::posix_time::time_duration duration = Time_Traits::to_posix_duration(
- Time_Traits::subtract(heap_[0].time_, Time_Traits::now()));
-
- if (duration > boost::posix_time::milliseconds(max_duration))
- duration = boost::posix_time::milliseconds(max_duration);
- else if (duration <= boost::posix_time::milliseconds(0))
- duration = boost::posix_time::milliseconds(0);
- else if (duration < boost::posix_time::milliseconds(1))
- duration = boost::posix_time::milliseconds(1);
-
- return duration.total_milliseconds();
+ return this->to_msec(
+ Time_Traits::to_posix_duration(
+ Time_Traits::subtract(heap_[0].time_, Time_Traits::now())),
+ max_duration);
}
// Get the time for the timer that is earliest in the queue.
@@ -143,17 +133,10 @@
if (heap_.empty())
return max_duration;
- boost::posix_time::time_duration duration = Time_Traits::to_posix_duration(
- Time_Traits::subtract(heap_[0].time_, Time_Traits::now()));
-
- if (duration > boost::posix_time::microseconds(max_duration))
- duration = boost::posix_time::microseconds(max_duration);
- else if (duration <= boost::posix_time::microseconds(0))
- duration = boost::posix_time::microseconds(0);
- else if (duration < boost::posix_time::microseconds(1))
- duration = boost::posix_time::microseconds(1);
-
- return duration.total_microseconds();
+ return this->to_usec(
+ Time_Traits::to_posix_duration(
+ Time_Traits::subtract(heap_[0].time_, Time_Traits::now())),
+ max_duration);
}
// Dequeue all timers not later than the current time.
@@ -193,7 +176,7 @@
std::size_t num_cancelled = 0;
if (timer.prev_ != 0 || &timer == timers_)
{
- while (timer_op* op = (num_cancelled != max_cancelled)
+ while (wait_op* op = (num_cancelled != max_cancelled)
? timer.op_queue_.front() : 0)
{
op->ec_ = boost::asio::error::operation_aborted;
@@ -292,9 +275,39 @@
}
// Determine if the specified absolute time is positive infinity.
- static bool is_positive_infinity(const boost::posix_time::ptime& time)
- {
- return time == boost::posix_time::pos_infin;
+ template <typename T, typename TimeSystem>
+ static bool is_positive_infinity(
+ const boost::date_time::base_time<T, TimeSystem>& time)
+ {
+ return time.is_pos_infinity();
+ }
+
+ // Helper function to convert a duration into milliseconds.
+ template <typename Duration>
+ long to_msec(const Duration& d, long max_duration) const
+ {
+ if (d.ticks() <= 0)
+ return 0;
+ boost::int64_t msec = d.total_milliseconds();
+ if (msec == 0)
+ return 1;
+ if (msec > max_duration)
+ return max_duration;
+ return static_cast<long>(msec);
+ }
+
+ // Helper function to convert a duration into microseconds.
+ template <typename Duration>
+ long to_usec(const Duration& d, long max_duration) const
+ {
+ if (d.ticks() <= 0)
+ return 0;
+ boost::int64_t usec = d.total_microseconds();
+ if (usec == 0)
+ return 1;
+ if (usec > max_duration)
+ return max_duration;
+ return static_cast<long>(usec);
}
// The head of a linked list of all active timers.
@@ -313,64 +326,6 @@
std::vector<heap_entry> heap_;
};
-#if !defined(BOOST_ASIO_HEADER_ONLY)
-
-struct forwarding_posix_time_traits : time_traits<boost::posix_time::ptime> {};
-
-// Template specialisation for the commonly used instantation.
-template <>
-class timer_queue<time_traits<boost::posix_time::ptime> >
- : public timer_queue_base
-{
-public:
- // The time type.
- typedef boost::posix_time::ptime time_type;
-
- // The duration type.
- typedef boost::posix_time::time_duration duration_type;
-
- // Per-timer data.
- typedef timer_queue<forwarding_posix_time_traits>::per_timer_data
- per_timer_data;
-
- // Constructor.
- BOOST_ASIO_DECL timer_queue();
-
- // Destructor.
- BOOST_ASIO_DECL virtual ~timer_queue();
-
- // Add a new timer to the queue. Returns true if this is the timer that is
- // earliest in the queue, in which case the reactor's event demultiplexing
- // function call may need to be interrupted and restarted.
- BOOST_ASIO_DECL bool enqueue_timer(const time_type& time,
- per_timer_data& timer, timer_op* op);
-
- // Whether there are no timers in the queue.
- BOOST_ASIO_DECL virtual bool empty() const;
-
- // Get the time for the timer that is earliest in the queue.
- BOOST_ASIO_DECL virtual long wait_duration_msec(long max_duration) const;
-
- // Get the time for the timer that is earliest in the queue.
- BOOST_ASIO_DECL virtual long wait_duration_usec(long max_duration) const;
-
- // Dequeue all timers not later than the current time.
- BOOST_ASIO_DECL virtual void get_ready_timers(op_queue<operation>& ops);
-
- // Dequeue all timers.
- BOOST_ASIO_DECL virtual void get_all_timers(op_queue<operation>& ops);
-
- // Cancel and dequeue operations for the given timer.
- BOOST_ASIO_DECL std::size_t cancel_timer(
- per_timer_data& timer, op_queue<operation>& ops,
- std::size_t max_cancelled = (std::numeric_limits<std::size_t>::max)());
-
-private:
- timer_queue<forwarding_posix_time_traits> impl_;
-};
-
-#endif // !defined(BOOST_ASIO_HEADER_ONLY)
-
} // namespace detail
} // namespace asio
} // namespace boost
Modified: branches/release/boost/asio/detail/timer_queue_base.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_queue_base.hpp (original)
+++ branches/release/boost/asio/detail/timer_queue_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_queue_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/timer_queue_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_queue_fwd.hpp (original)
+++ branches/release/boost/asio/detail/timer_queue_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_queue_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/timer_queue_ptime.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/timer_queue_ptime.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,91 @@
+//
+// detail/timer_queue_ptime.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_DETAIL_TIMER_QUEUE_PTIME_HPP
+#define BOOST_ASIO_DETAIL_TIMER_QUEUE_PTIME_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/time_traits.hpp>
+#include <boost/asio/detail/timer_queue.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+struct forwarding_posix_time_traits : time_traits<boost::posix_time::ptime> {};
+
+// Template specialisation for the commonly used instantation.
+template <>
+class timer_queue<time_traits<boost::posix_time::ptime> >
+ : public timer_queue_base
+{
+public:
+ // The time type.
+ typedef boost::posix_time::ptime time_type;
+
+ // The duration type.
+ typedef boost::posix_time::time_duration duration_type;
+
+ // Per-timer data.
+ typedef timer_queue<forwarding_posix_time_traits>::per_timer_data
+ per_timer_data;
+
+ // Constructor.
+ BOOST_ASIO_DECL timer_queue();
+
+ // Destructor.
+ BOOST_ASIO_DECL virtual ~timer_queue();
+
+ // Add a new timer to the queue. Returns true if this is the timer that is
+ // earliest in the queue, in which case the reactor's event demultiplexing
+ // function call may need to be interrupted and restarted.
+ BOOST_ASIO_DECL bool enqueue_timer(const time_type& time,
+ per_timer_data& timer, wait_op* op);
+
+ // Whether there are no timers in the queue.
+ BOOST_ASIO_DECL virtual bool empty() const;
+
+ // Get the time for the timer that is earliest in the queue.
+ BOOST_ASIO_DECL virtual long wait_duration_msec(long max_duration) const;
+
+ // Get the time for the timer that is earliest in the queue.
+ BOOST_ASIO_DECL virtual long wait_duration_usec(long max_duration) const;
+
+ // Dequeue all timers not later than the current time.
+ BOOST_ASIO_DECL virtual void get_ready_timers(op_queue<operation>& ops);
+
+ // Dequeue all timers.
+ BOOST_ASIO_DECL virtual void get_all_timers(op_queue<operation>& ops);
+
+ // Cancel and dequeue operations for the given timer.
+ BOOST_ASIO_DECL std::size_t cancel_timer(
+ per_timer_data& timer, op_queue<operation>& ops,
+ std::size_t max_cancelled = (std::numeric_limits<std::size_t>::max)());
+
+private:
+ timer_queue<forwarding_posix_time_traits> impl_;
+};
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#if defined(BOOST_ASIO_HEADER_ONLY)
+# include <boost/asio/detail/impl/timer_queue_ptime.ipp>
+#endif // defined(BOOST_ASIO_HEADER_ONLY)
+
+#endif // BOOST_ASIO_DETAIL_TIMER_QUEUE_PTIME_HPP
Modified: branches/release/boost/asio/detail/timer_queue_set.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_queue_set.hpp (original)
+++ branches/release/boost/asio/detail/timer_queue_set.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_queue_set.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/timer_scheduler.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_scheduler.hpp (original)
+++ branches/release/boost/asio/detail/timer_scheduler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_scheduler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/timer_scheduler_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/timer_scheduler_fwd.hpp (original)
+++ branches/release/boost/asio/detail/timer_scheduler_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/timer_scheduler_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/tss_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/tss_ptr.hpp (original)
+++ branches/release/boost/asio/detail/tss_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/tss_ptr.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/wait_handler.hpp
==============================================================================
--- branches/release/boost/asio/detail/wait_handler.hpp (original)
+++ branches/release/boost/asio/detail/wait_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/wait_handler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -19,7 +19,8 @@
#include <boost/asio/detail/fenced_block.hpp>
#include <boost/asio/detail/handler_alloc_helpers.hpp>
#include <boost/asio/detail/handler_invoke_helpers.hpp>
-#include <boost/asio/detail/timer_op.hpp>
+#include <boost/asio/detail/wait_op.hpp>
+#include <boost/asio/io_service.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -28,13 +29,13 @@
namespace detail {
template <typename Handler>
-class wait_handler : public timer_op
+class wait_handler : public wait_op
{
public:
BOOST_ASIO_DEFINE_HANDLER_PTR(wait_handler);
wait_handler(Handler& h)
- : timer_op(&wait_handler::do_complete),
+ : wait_op(&wait_handler::do_complete),
handler_(BOOST_ASIO_MOVE_CAST(Handler)(h))
{
}
Added: branches/release/boost/asio/detail/wait_op.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/wait_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,47 @@
+//
+// detail/wait_op.hpp
+// ~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_DETAIL_WAIT_OP_HPP
+#define BOOST_ASIO_DETAIL_WAIT_OP_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/detail/operation.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+class wait_op
+ : public operation
+{
+public:
+ // The error code to be passed to the completion handler.
+ boost::system::error_code ec_;
+
+protected:
+ wait_op(func_type func)
+ : operation(func)
+ {
+ }
+};
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_DETAIL_WAIT_OP_HPP
Modified: branches/release/boost/asio/detail/weak_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/weak_ptr.hpp (original)
+++ branches/release/boost/asio/detail/weak_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/weak_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_event.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_event.hpp (original)
+++ branches/release/boost/asio/detail/win_event.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_event.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_fd_set_adapter.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_fd_set_adapter.hpp (original)
+++ branches/release/boost/asio/detail/win_fd_set_adapter.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_fd_set_adapter.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_fenced_block.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_fenced_block.hpp (original)
+++ branches/release/boost/asio/detail/win_fenced_block.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_fenced_block.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_handle_read_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_handle_read_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_handle_read_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_handle_read_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/win_iocp_handle_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_handle_service.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_handle_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_handle_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/win_iocp_handle_write_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_handle_write_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_handle_write_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_handle_write_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/win_iocp_io_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_io_service.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_io_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -26,13 +26,13 @@
#include <boost/asio/detail/op_queue.hpp>
#include <boost/asio/detail/scoped_ptr.hpp>
#include <boost/asio/detail/socket_types.hpp>
-#include <boost/asio/detail/timer_op.hpp>
+#include <boost/asio/detail/thread.hpp>
#include <boost/asio/detail/timer_queue_base.hpp>
#include <boost/asio/detail/timer_queue_fwd.hpp>
#include <boost/asio/detail/timer_queue_set.hpp>
+#include <boost/asio/detail/wait_op.hpp>
#include <boost/asio/detail/win_iocp_io_service_fwd.hpp>
#include <boost/asio/detail/win_iocp_operation.hpp>
-#include <boost/asio/detail/thread.hpp>
#include <boost/asio/detail/push_options.hpp>
@@ -40,7 +40,7 @@
namespace asio {
namespace detail {
-class timer_op;
+class wait_op;
class win_iocp_io_service
: public boost::asio::detail::service_base<win_iocp_io_service>
@@ -169,7 +169,7 @@
template <typename Time_Traits>
void schedule_timer(timer_queue<Time_Traits>& queue,
const typename Time_Traits::time_type& time,
- typename timer_queue<Time_Traits>::per_timer_data& timer, timer_op* op);
+ typename timer_queue<Time_Traits>::per_timer_data& timer, wait_op* op);
// Cancel the timer associated with the given token. Returns the number of
// handlers that have been posted or dispatched.
Modified: branches/release/boost/asio/detail/win_iocp_io_service_fwd.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_io_service_fwd.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_io_service_fwd.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_io_service_fwd.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_null_buffers_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_null_buffers_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_null_buffers_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_null_buffers_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_operation.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_operation.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_operation.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_operation.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -21,6 +21,7 @@
#include <boost/asio/detail/handler_tracking.hpp>
#include <boost/asio/detail/op_queue.hpp>
+#include <boost/asio/detail/socket_types.hpp>
#include <boost/asio/detail/win_iocp_io_service_fwd.hpp>
#include <boost/system/error_code.hpp>
Modified: branches/release/boost/asio/detail/win_iocp_overlapped_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_overlapped_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_overlapped_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_overlapped_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_overlapped_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_overlapped_ptr.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_overlapped_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_overlapped_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_serial_port_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_serial_port_service.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_serial_port_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_serial_port_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/detail/win_iocp_socket_accept_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_accept_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_accept_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_accept_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_recv_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_recv_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_recv_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_recv_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_recvfrom_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_recvfrom_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_recvfrom_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_recvfrom_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_recvmsg_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_recvmsg_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_recvmsg_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_recvmsg_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_send_op.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_send_op.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_send_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_send_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_service.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_iocp_socket_service_base.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_iocp_socket_service_base.hpp (original)
+++ branches/release/boost/asio/detail/win_iocp_socket_service_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_iocp_socket_service_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_mutex.hpp (original)
+++ branches/release/boost/asio/detail/win_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/detail/win_object_handle_service.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/detail/win_object_handle_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,185 @@
+//
+// detail/win_object_handle_service.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2011 Boris Schaeling (boris_at_[hidden])
+//
+// 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_DETAIL_WIN_OBJECT_HANDLE_SERVICE_HPP
+#define BOOST_ASIO_DETAIL_WIN_OBJECT_HANDLE_SERVICE_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+
+#include <boost/utility/addressof.hpp>
+#include <boost/asio/detail/handler_alloc_helpers.hpp>
+#include <boost/asio/detail/wait_handler.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/io_service.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace detail {
+
+class win_object_handle_service
+{
+public:
+ // The native type of an object handle.
+ typedef HANDLE native_handle_type;
+
+ // The implementation type of the object handle.
+ class implementation_type
+ {
+ public:
+ // Default constructor.
+ implementation_type()
+ : handle_(INVALID_HANDLE_VALUE),
+ wait_handle_(INVALID_HANDLE_VALUE),
+ owner_(0),
+ next_(0),
+ prev_(0)
+ {
+ }
+
+ private:
+ // Only this service will have access to the internal values.
+ friend class win_object_handle_service;
+
+ // The native object handle representation. May be accessed or modified
+ // without locking the mutex.
+ native_handle_type handle_;
+
+ // The handle used to unregister the wait operation. The mutex must be
+ // locked when accessing or modifying this member.
+ HANDLE wait_handle_;
+
+ // The operations waiting on the object handle. If there is a registered
+ // wait then the mutex must be locked when accessing or modifying this
+ // member
+ op_queue<wait_op> op_queue_;
+
+ // The service instance that owns the object handle implementation.
+ win_object_handle_service* owner_;
+
+ // Pointers to adjacent handle implementations in linked list. The mutex
+ // must be locked when accessing or modifying these members.
+ implementation_type* next_;
+ implementation_type* prev_;
+ };
+
+ // Constructor.
+ BOOST_ASIO_DECL win_object_handle_service(
+ boost::asio::io_service& io_service);
+
+ // Destroy all user-defined handler objects owned by the service.
+ BOOST_ASIO_DECL void shutdown_service();
+
+ // Construct a new handle implementation.
+ BOOST_ASIO_DECL void construct(implementation_type& impl);
+
+ // Move-construct a new handle implementation.
+ BOOST_ASIO_DECL void move_construct(implementation_type& impl,
+ implementation_type& other_impl);
+
+ // Move-assign from another handle implementation.
+ BOOST_ASIO_DECL void move_assign(implementation_type& impl,
+ win_object_handle_service& other_service,
+ implementation_type& other_impl);
+
+ // Destroy a handle implementation.
+ BOOST_ASIO_DECL void destroy(implementation_type& impl);
+
+ // Assign a native handle to a handle implementation.
+ BOOST_ASIO_DECL boost::system::error_code assign(implementation_type& impl,
+ const native_handle_type& handle, boost::system::error_code& ec);
+
+ // Determine whether the handle is open.
+ bool is_open(const implementation_type& impl) const
+ {
+ return impl.handle_ != INVALID_HANDLE_VALUE && impl.handle_ != 0;
+ }
+
+ // Destroy a handle implementation.
+ BOOST_ASIO_DECL boost::system::error_code close(implementation_type& impl,
+ boost::system::error_code& ec);
+
+ // Get the native handle representation.
+ native_handle_type native_handle(const implementation_type& impl) const
+ {
+ return impl.handle_;
+ }
+
+ // Cancel all operations associated with the handle.
+ BOOST_ASIO_DECL boost::system::error_code cancel(implementation_type& impl,
+ boost::system::error_code& ec);
+
+ // Perform a synchronous wait for the object to enter a signalled state.
+ BOOST_ASIO_DECL void wait(implementation_type& impl,
+ boost::system::error_code& ec);
+
+ /// Start an asynchronous wait.
+ template <typename Handler>
+ void async_wait(implementation_type& impl, Handler handler)
+ {
+ // Allocate and construct an operation to wrap the handler.
+ typedef wait_handler<Handler> op;
+ typename op::ptr p = { boost::addressof(handler),
+ boost_asio_handler_alloc_helpers::allocate(
+ sizeof(op), handler), 0 };
+ p.p = new (p.v) op(handler);
+
+ BOOST_ASIO_HANDLER_CREATION((p.p, "object_handle", &impl, "async_wait"));
+
+ start_wait_op(impl, p.p);
+ p.v = p.p = 0;
+ }
+
+private:
+ // Helper function to start an asynchronous wait operation.
+ BOOST_ASIO_DECL void start_wait_op(implementation_type& impl, wait_op* op);
+
+ // Helper function to register a wait operation.
+ BOOST_ASIO_DECL void register_wait_callback(
+ implementation_type& impl, mutex::scoped_lock& lock);
+
+ // Callback function invoked when the registered wait completes.
+ static BOOST_ASIO_DECL VOID CALLBACK wait_callback(
+ PVOID param, BOOLEAN timeout);
+
+ // The io_service implementation used to post completions.
+ io_service_impl& io_service_;
+
+ // Mutex to protect access to internal state.
+ mutex mutex_;
+
+ // The head of a linked list of all implementations.
+ implementation_type* impl_list_;
+
+ // Flag to indicate that the dispatcher has been shut down.
+ bool shutdown_;
+};
+
+} // namespace detail
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#if defined(BOOST_ASIO_HEADER_ONLY)
+# include <boost/asio/detail/impl/win_object_handle_service.ipp>
+#endif // defined(BOOST_ASIO_HEADER_ONLY)
+
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+
+#endif // BOOST_ASIO_DETAIL_WIN_OBJECT_HANDLE_SERVICE_HPP
Modified: branches/release/boost/asio/detail/win_static_mutex.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_static_mutex.hpp (original)
+++ branches/release/boost/asio/detail/win_static_mutex.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_static_mutex.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_thread.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_thread.hpp (original)
+++ branches/release/boost/asio/detail/win_thread.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_thread.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/win_tss_ptr.hpp
==============================================================================
--- branches/release/boost/asio/detail/win_tss_ptr.hpp (original)
+++ branches/release/boost/asio/detail/win_tss_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/win_tss_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/wince_thread.hpp
==============================================================================
--- branches/release/boost/asio/detail/wince_thread.hpp (original)
+++ branches/release/boost/asio/detail/wince_thread.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/wince_thread.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/winsock_init.hpp
==============================================================================
--- branches/release/boost/asio/detail/winsock_init.hpp (original)
+++ branches/release/boost/asio/detail/winsock_init.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/winsock_init.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/detail/wrapped_handler.hpp
==============================================================================
--- branches/release/boost/asio/detail/wrapped_handler.hpp (original)
+++ branches/release/boost/asio/detail/wrapped_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/wrapped_handler.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/error.hpp
==============================================================================
--- branches/release/boost/asio/error.hpp (original)
+++ branches/release/boost/asio/error.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// error.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/handler_alloc_hook.hpp
==============================================================================
--- branches/release/boost/asio/handler_alloc_hook.hpp (original)
+++ branches/release/boost/asio/handler_alloc_hook.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// handler_alloc_hook.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/handler_invoke_hook.hpp
==============================================================================
--- branches/release/boost/asio/handler_invoke_hook.hpp (original)
+++ branches/release/boost/asio/handler_invoke_hook.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// handler_invoke_hook.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/high_resolution_timer.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/high_resolution_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,65 @@
+//
+// high_resolution_timer.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_HIGH_RESOLUTION_TIMER_HPP
+#define BOOST_ASIO_HIGH_RESOLUTION_TIMER_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO) \
+ || defined(BOOST_ASIO_HAS_BOOST_CHRONO) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO)
+# include <chrono>
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+# include <boost/chrono/system_clocks.hpp>
+#endif
+
+#include <boost/asio/basic_waitable_timer.hpp>
+
+namespace boost {
+namespace asio {
+
+#if defined(GENERATING_DOCUMENTATION)
+/// Typedef for a timer based on the high resolution clock.
+/**
+ * This typedef uses the C++11 @c <chrono> standard library facility, if
+ * available. Otherwise, it may use the Boost.Chrono library. To explicitly
+ * utilise Boost.Chrono, use the basic_waitable_timer template directly:
+ * @code
+ * typedef basic_waitable_timer<boost::chrono::high_resolution_clock> timer;
+ * @endcode
+ */
+typedef basic_waitable_timer<
+ chrono::high_resolution_clock>
+ high_resolution_timer;
+#elif defined(BOOST_ASIO_HAS_STD_CHRONO)
+typedef basic_waitable_timer<
+ std::chrono::high_resolution_clock>
+ high_resolution_timer;
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+typedef basic_waitable_timer<
+ boost::chrono::high_resolution_clock>
+ high_resolution_timer;
+#endif
+
+} // namespace asio
+} // namespace boost
+
+#endif // defined(BOOST_ASIO_HAS_STD_CHRONO)
+ // || defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_HIGH_RESOLUTION_TIMER_HPP
Modified: branches/release/boost/asio/impl/connect.hpp
==============================================================================
--- branches/release/boost/asio/impl/connect.hpp (original)
+++ branches/release/boost/asio/impl/connect.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/connect.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/error.ipp
==============================================================================
--- branches/release/boost/asio/impl/error.ipp (original)
+++ branches/release/boost/asio/impl/error.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/error.ipp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/io_service.hpp
==============================================================================
--- branches/release/boost/asio/impl/io_service.hpp (original)
+++ branches/release/boost/asio/impl/io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/io_service.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/io_service.ipp
==============================================================================
--- branches/release/boost/asio/impl/io_service.ipp (original)
+++ branches/release/boost/asio/impl/io_service.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/io_service.ipp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/read.hpp
==============================================================================
--- branches/release/boost/asio/impl/read.hpp (original)
+++ branches/release/boost/asio/impl/read.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/read.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/read_at.hpp
==============================================================================
--- branches/release/boost/asio/impl/read_at.hpp (original)
+++ branches/release/boost/asio/impl/read_at.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/read_at.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/read_until.hpp
==============================================================================
--- branches/release/boost/asio/impl/read_until.hpp (original)
+++ branches/release/boost/asio/impl/read_until.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/read_until.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/serial_port_base.hpp
==============================================================================
--- branches/release/boost/asio/impl/serial_port_base.hpp (original)
+++ branches/release/boost/asio/impl/serial_port_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/serial_port_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/impl/serial_port_base.ipp
==============================================================================
--- branches/release/boost/asio/impl/serial_port_base.ipp (original)
+++ branches/release/boost/asio/impl/serial_port_base.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/serial_port_base.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/impl/src.cpp
==============================================================================
--- branches/release/boost/asio/impl/src.cpp (original)
+++ branches/release/boost/asio/impl/src.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/src.cpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/src.hpp
==============================================================================
--- branches/release/boost/asio/impl/src.hpp (original)
+++ branches/release/boost/asio/impl/src.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/src.hpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -45,7 +45,7 @@
#include <boost/asio/detail/impl/strand_service.ipp>
#include <boost/asio/detail/impl/task_io_service.ipp>
#include <boost/asio/detail/impl/throw_error.ipp>
-#include <boost/asio/detail/impl/timer_queue.ipp>
+#include <boost/asio/detail/impl/timer_queue_ptime.ipp>
#include <boost/asio/detail/impl/timer_queue_set.ipp>
#include <boost/asio/detail/impl/win_iocp_handle_service.ipp>
#include <boost/asio/detail/impl/win_iocp_io_service.ipp>
@@ -53,6 +53,7 @@
#include <boost/asio/detail/impl/win_iocp_socket_service_base.ipp>
#include <boost/asio/detail/impl/win_event.ipp>
#include <boost/asio/detail/impl/win_mutex.ipp>
+#include <boost/asio/detail/impl/win_object_handle_service.ipp>
#include <boost/asio/detail/impl/win_static_mutex.ipp>
#include <boost/asio/detail/impl/win_thread.ipp>
#include <boost/asio/detail/impl/win_tss_ptr.ipp>
Modified: branches/release/boost/asio/impl/write.hpp
==============================================================================
--- branches/release/boost/asio/impl/write.hpp (original)
+++ branches/release/boost/asio/impl/write.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/write.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/impl/write_at.hpp
==============================================================================
--- branches/release/boost/asio/impl/write_at.hpp (original)
+++ branches/release/boost/asio/impl/write_at.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/write_at.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/io_service.hpp
==============================================================================
--- branches/release/boost/asio/io_service.hpp (original)
+++ branches/release/boost/asio/io_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// io_service.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/address.hpp
==============================================================================
--- branches/release/boost/asio/ip/address.hpp (original)
+++ branches/release/boost/asio/ip/address.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/address.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/address_v4.hpp
==============================================================================
--- branches/release/boost/asio/ip/address_v4.hpp (original)
+++ branches/release/boost/asio/ip/address_v4.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/address_v4.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/address_v6.hpp
==============================================================================
--- branches/release/boost/asio/ip/address_v6.hpp (original)
+++ branches/release/boost/asio/ip/address_v6.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/address_v6.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/basic_endpoint.hpp
==============================================================================
--- branches/release/boost/asio/ip/basic_endpoint.hpp (original)
+++ branches/release/boost/asio/ip/basic_endpoint.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/basic_endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/basic_resolver.hpp
==============================================================================
--- branches/release/boost/asio/ip/basic_resolver.hpp (original)
+++ branches/release/boost/asio/ip/basic_resolver.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/basic_resolver.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/basic_resolver_entry.hpp
==============================================================================
--- branches/release/boost/asio/ip/basic_resolver_entry.hpp (original)
+++ branches/release/boost/asio/ip/basic_resolver_entry.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/basic_resolver_entry.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/basic_resolver_iterator.hpp
==============================================================================
--- branches/release/boost/asio/ip/basic_resolver_iterator.hpp (original)
+++ branches/release/boost/asio/ip/basic_resolver_iterator.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/basic_resolver_iterator.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/basic_resolver_query.hpp
==============================================================================
--- branches/release/boost/asio/ip/basic_resolver_query.hpp (original)
+++ branches/release/boost/asio/ip/basic_resolver_query.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/basic_resolver_query.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/detail/endpoint.hpp
==============================================================================
--- branches/release/boost/asio/ip/detail/endpoint.hpp (original)
+++ branches/release/boost/asio/ip/detail/endpoint.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/detail/endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/detail/impl/endpoint.ipp
==============================================================================
--- branches/release/boost/asio/ip/detail/impl/endpoint.ipp (original)
+++ branches/release/boost/asio/ip/detail/impl/endpoint.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/detail/impl/endpoint.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/detail/socket_option.hpp
==============================================================================
--- branches/release/boost/asio/ip/detail/socket_option.hpp (original)
+++ branches/release/boost/asio/ip/detail/socket_option.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// detail/socket_option.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/host_name.hpp
==============================================================================
--- branches/release/boost/asio/ip/host_name.hpp (original)
+++ branches/release/boost/asio/ip/host_name.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/host_name.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/icmp.hpp
==============================================================================
--- branches/release/boost/asio/ip/icmp.hpp (original)
+++ branches/release/boost/asio/ip/icmp.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/icmp.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address.hpp
==============================================================================
--- branches/release/boost/asio/ip/impl/address.hpp (original)
+++ branches/release/boost/asio/ip/impl/address.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address.ipp
==============================================================================
--- branches/release/boost/asio/ip/impl/address.ipp (original)
+++ branches/release/boost/asio/ip/impl/address.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address.ipp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address_v4.hpp
==============================================================================
--- branches/release/boost/asio/ip/impl/address_v4.hpp (original)
+++ branches/release/boost/asio/ip/impl/address_v4.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address_v4.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address_v4.ipp
==============================================================================
--- branches/release/boost/asio/ip/impl/address_v4.ipp (original)
+++ branches/release/boost/asio/ip/impl/address_v4.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address_v4.ipp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address_v6.hpp
==============================================================================
--- branches/release/boost/asio/ip/impl/address_v6.hpp (original)
+++ branches/release/boost/asio/ip/impl/address_v6.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address_v6.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/address_v6.ipp
==============================================================================
--- branches/release/boost/asio/ip/impl/address_v6.ipp (original)
+++ branches/release/boost/asio/ip/impl/address_v6.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/address_v6.ipp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/basic_endpoint.hpp
==============================================================================
--- branches/release/boost/asio/ip/impl/basic_endpoint.hpp (original)
+++ branches/release/boost/asio/ip/impl/basic_endpoint.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/basic_endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/impl/host_name.ipp
==============================================================================
--- branches/release/boost/asio/ip/impl/host_name.ipp (original)
+++ branches/release/boost/asio/ip/impl/host_name.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/impl/host_name.ipp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/multicast.hpp
==============================================================================
--- branches/release/boost/asio/ip/multicast.hpp (original)
+++ branches/release/boost/asio/ip/multicast.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/multicast.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/resolver_query_base.hpp
==============================================================================
--- branches/release/boost/asio/ip/resolver_query_base.hpp (original)
+++ branches/release/boost/asio/ip/resolver_query_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/resolver_query_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/resolver_service.hpp
==============================================================================
--- branches/release/boost/asio/ip/resolver_service.hpp (original)
+++ branches/release/boost/asio/ip/resolver_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/resolver_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/tcp.hpp
==============================================================================
--- branches/release/boost/asio/ip/tcp.hpp (original)
+++ branches/release/boost/asio/ip/tcp.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/tcp.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/udp.hpp
==============================================================================
--- branches/release/boost/asio/ip/udp.hpp (original)
+++ branches/release/boost/asio/ip/udp.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/udp.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/unicast.hpp
==============================================================================
--- branches/release/boost/asio/ip/unicast.hpp (original)
+++ branches/release/boost/asio/ip/unicast.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/unicast.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ip/v6_only.hpp
==============================================================================
--- branches/release/boost/asio/ip/v6_only.hpp (original)
+++ branches/release/boost/asio/ip/v6_only.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ip/v6_only.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/is_read_buffered.hpp
==============================================================================
--- branches/release/boost/asio/is_read_buffered.hpp (original)
+++ branches/release/boost/asio/is_read_buffered.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// is_read_buffered.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/is_write_buffered.hpp
==============================================================================
--- branches/release/boost/asio/is_write_buffered.hpp (original)
+++ branches/release/boost/asio/is_write_buffered.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// is_write_buffered.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/local/basic_endpoint.hpp
==============================================================================
--- branches/release/boost/asio/local/basic_endpoint.hpp (original)
+++ branches/release/boost/asio/local/basic_endpoint.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/basic_endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Derived from a public domain implementation written by Daniel Casimiro.
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/local/connect_pair.hpp
==============================================================================
--- branches/release/boost/asio/local/connect_pair.hpp (original)
+++ branches/release/boost/asio/local/connect_pair.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/connect_pair.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/local/datagram_protocol.hpp
==============================================================================
--- branches/release/boost/asio/local/datagram_protocol.hpp (original)
+++ branches/release/boost/asio/local/datagram_protocol.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/datagram_protocol.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/local/detail/endpoint.hpp
==============================================================================
--- branches/release/boost/asio/local/detail/endpoint.hpp (original)
+++ branches/release/boost/asio/local/detail/endpoint.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/detail/endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Derived from a public domain implementation written by Daniel Casimiro.
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/local/detail/impl/endpoint.ipp
==============================================================================
--- branches/release/boost/asio/local/detail/impl/endpoint.ipp (original)
+++ branches/release/boost/asio/local/detail/impl/endpoint.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/detail/impl/endpoint.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Derived from a public domain implementation written by Daniel Casimiro.
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/local/stream_protocol.hpp
==============================================================================
--- branches/release/boost/asio/local/stream_protocol.hpp (original)
+++ branches/release/boost/asio/local/stream_protocol.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// local/stream_protocol.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/placeholders.hpp
==============================================================================
--- branches/release/boost/asio/placeholders.hpp (original)
+++ branches/release/boost/asio/placeholders.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// placeholders.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/posix/basic_descriptor.hpp
==============================================================================
--- branches/release/boost/asio/posix/basic_descriptor.hpp (original)
+++ branches/release/boost/asio/posix/basic_descriptor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix/basic_descriptor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/posix/basic_stream_descriptor.hpp
==============================================================================
--- branches/release/boost/asio/posix/basic_stream_descriptor.hpp (original)
+++ branches/release/boost/asio/posix/basic_stream_descriptor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix/basic_stream_descriptor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/posix/descriptor_base.hpp
==============================================================================
--- branches/release/boost/asio/posix/descriptor_base.hpp (original)
+++ branches/release/boost/asio/posix/descriptor_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix/descriptor_base.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/posix/stream_descriptor.hpp
==============================================================================
--- branches/release/boost/asio/posix/stream_descriptor.hpp (original)
+++ branches/release/boost/asio/posix/stream_descriptor.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix/stream_descriptor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/posix/stream_descriptor_service.hpp
==============================================================================
--- branches/release/boost/asio/posix/stream_descriptor_service.hpp (original)
+++ branches/release/boost/asio/posix/stream_descriptor_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix/stream_descriptor_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/raw_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/raw_socket_service.hpp (original)
+++ branches/release/boost/asio/raw_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// raw_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/read.hpp
==============================================================================
--- branches/release/boost/asio/read.hpp (original)
+++ branches/release/boost/asio/read.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read.hpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/read_at.hpp
==============================================================================
--- branches/release/boost/asio/read_at.hpp (original)
+++ branches/release/boost/asio/read_at.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read_at.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/read_until.hpp
==============================================================================
--- branches/release/boost/asio/read_until.hpp (original)
+++ branches/release/boost/asio/read_until.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read_until.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/seq_packet_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/seq_packet_socket_service.hpp (original)
+++ branches/release/boost/asio/seq_packet_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// seq_packet_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/serial_port.hpp
==============================================================================
--- branches/release/boost/asio/serial_port.hpp (original)
+++ branches/release/boost/asio/serial_port.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/serial_port_base.hpp
==============================================================================
--- branches/release/boost/asio/serial_port_base.hpp (original)
+++ branches/release/boost/asio/serial_port_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port_base.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/boost/asio/serial_port_service.hpp
==============================================================================
--- branches/release/boost/asio/serial_port_service.hpp (original)
+++ branches/release/boost/asio/serial_port_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/signal_set.hpp
==============================================================================
--- branches/release/boost/asio/signal_set.hpp (original)
+++ branches/release/boost/asio/signal_set.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// signal_set.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/signal_set_service.hpp
==============================================================================
--- branches/release/boost/asio/signal_set_service.hpp (original)
+++ branches/release/boost/asio/signal_set_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// signal_set_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/socket_acceptor_service.hpp
==============================================================================
--- branches/release/boost/asio/socket_acceptor_service.hpp (original)
+++ branches/release/boost/asio/socket_acceptor_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// socket_acceptor_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/socket_base.hpp
==============================================================================
--- branches/release/boost/asio/socket_base.hpp (original)
+++ branches/release/boost/asio/socket_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// socket_base.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl.hpp
==============================================================================
--- branches/release/boost/asio/ssl.hpp (original)
+++ branches/release/boost/asio/ssl.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl.hpp
// ~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/basic_context.hpp
==============================================================================
--- branches/release/boost/asio/ssl/basic_context.hpp (original)
+++ branches/release/boost/asio/ssl/basic_context.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/basic_context.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/context.hpp
==============================================================================
--- branches/release/boost/asio/ssl/context.hpp (original)
+++ branches/release/boost/asio/ssl/context.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/context.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/context_base.hpp
==============================================================================
--- branches/release/boost/asio/ssl/context_base.hpp (original)
+++ branches/release/boost/asio/ssl/context_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/context_base.hpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/context_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/context_service.hpp (original)
+++ branches/release/boost/asio/ssl/context_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/context_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/engine.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/engine.hpp (original)
+++ branches/release/boost/asio/ssl/detail/engine.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/engine.hpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/handshake_op.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/handshake_op.hpp (original)
+++ branches/release/boost/asio/ssl/detail/handshake_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/handshake_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/impl/engine.ipp
==============================================================================
--- branches/release/boost/asio/ssl/detail/impl/engine.ipp (original)
+++ branches/release/boost/asio/ssl/detail/impl/engine.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/impl/engine.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/impl/openssl_init.ipp
==============================================================================
--- branches/release/boost/asio/ssl/detail/impl/openssl_init.ipp (original)
+++ branches/release/boost/asio/ssl/detail/impl/openssl_init.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/detail/io.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/io.hpp (original)
+++ branches/release/boost/asio/ssl/detail/io.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/io.hpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/openssl_init.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/openssl_init.hpp (original)
+++ branches/release/boost/asio/ssl/detail/openssl_init.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/openssl_init.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/openssl_types.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/openssl_types.hpp (original)
+++ branches/release/boost/asio/ssl/detail/openssl_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/openssl_types.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/password_callback.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/password_callback.hpp (original)
+++ branches/release/boost/asio/ssl/detail/password_callback.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/password_callback.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/read_op.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/read_op.hpp (original)
+++ branches/release/boost/asio/ssl/detail/read_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/read_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/shutdown_op.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/shutdown_op.hpp (original)
+++ branches/release/boost/asio/ssl/detail/shutdown_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/shutdown_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/stream_core.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/stream_core.hpp (original)
+++ branches/release/boost/asio/ssl/detail/stream_core.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/stream_core.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/verify_callback.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/verify_callback.hpp (original)
+++ branches/release/boost/asio/ssl/detail/verify_callback.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/verify_callback.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/detail/write_op.hpp
==============================================================================
--- branches/release/boost/asio/ssl/detail/write_op.hpp (original)
+++ branches/release/boost/asio/ssl/detail/write_op.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/detail/write_op.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/error.hpp
==============================================================================
--- branches/release/boost/asio/ssl/error.hpp (original)
+++ branches/release/boost/asio/ssl/error.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/error.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/impl/context.hpp
==============================================================================
--- branches/release/boost/asio/ssl/impl/context.hpp (original)
+++ branches/release/boost/asio/ssl/impl/context.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/impl/context.ipp
==============================================================================
--- branches/release/boost/asio/ssl/impl/context.ipp (original)
+++ branches/release/boost/asio/ssl/impl/context.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/impl/error.ipp
==============================================================================
--- branches/release/boost/asio/ssl/impl/error.ipp (original)
+++ branches/release/boost/asio/ssl/impl/error.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/impl/error.ipp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/impl/rfc2818_verification.ipp
==============================================================================
--- branches/release/boost/asio/ssl/impl/rfc2818_verification.ipp (original)
+++ branches/release/boost/asio/ssl/impl/rfc2818_verification.ipp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/impl/rfc2818_verification.ipp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/impl/src.hpp
==============================================================================
--- branches/release/boost/asio/ssl/impl/src.hpp (original)
+++ branches/release/boost/asio/ssl/impl/src.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// impl/ssl/src.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/old/basic_context.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/basic_context.hpp (original)
+++ branches/release/boost/asio/ssl/old/basic_context.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/old/context_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/context_service.hpp (original)
+++ branches/release/boost/asio/ssl/old/context_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/old/detail/openssl_context_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/detail/openssl_context_service.hpp (original)
+++ branches/release/boost/asio/ssl/old/detail/openssl_context_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/old/detail/openssl_stream_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/detail/openssl_stream_service.hpp (original)
+++ branches/release/boost/asio/ssl/old/detail/openssl_stream_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/old/stream.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/stream.hpp (original)
+++ branches/release/boost/asio/ssl/old/stream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/old/stream_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/old/stream_service.hpp (original)
+++ branches/release/boost/asio/ssl/old/stream_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -3,7 +3,7 @@
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2005 Voipster / Indrek dot Juhani at voipster dot com
-// Copyright (c) 2005-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2005-2012 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)
Modified: branches/release/boost/asio/ssl/rfc2818_verification.hpp
==============================================================================
--- branches/release/boost/asio/ssl/rfc2818_verification.hpp (original)
+++ branches/release/boost/asio/ssl/rfc2818_verification.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/rfc2818_verification.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/stream.hpp
==============================================================================
--- branches/release/boost/asio/ssl/stream.hpp (original)
+++ branches/release/boost/asio/ssl/stream.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/stream.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/stream_base.hpp
==============================================================================
--- branches/release/boost/asio/ssl/stream_base.hpp (original)
+++ branches/release/boost/asio/ssl/stream_base.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/stream_base.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/stream_service.hpp
==============================================================================
--- branches/release/boost/asio/ssl/stream_service.hpp (original)
+++ branches/release/boost/asio/ssl/stream_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/stream_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/verify_context.hpp
==============================================================================
--- branches/release/boost/asio/ssl/verify_context.hpp (original)
+++ branches/release/boost/asio/ssl/verify_context.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/verify_context.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/ssl/verify_mode.hpp
==============================================================================
--- branches/release/boost/asio/ssl/verify_mode.hpp (original)
+++ branches/release/boost/asio/ssl/verify_mode.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ssl/verify_mode.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/steady_timer.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/steady_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,63 @@
+//
+// steady_timer.hpp
+// ~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_STEADY_TIMER_HPP
+#define BOOST_ASIO_STEADY_TIMER_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO) \
+ || defined(BOOST_ASIO_HAS_BOOST_CHRONO) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO)
+# include <chrono>
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+# include <boost/chrono/system_clocks.hpp>
+#endif
+
+#include <boost/asio/basic_waitable_timer.hpp>
+
+namespace boost {
+namespace asio {
+
+#if defined(GENERATING_DOCUMENTATION)
+/// Typedef for a timer based on the steady clock.
+/**
+ * This typedef uses the C++11 @c <chrono> standard library facility, if
+ * available. Otherwise, it may use the Boost.Chrono library. To explicitly
+ * utilise Boost.Chrono, use the basic_waitable_timer template directly:
+ * @code
+ * typedef basic_waitable_timer<boost::chrono::steady_clock> timer;
+ * @endcode
+ */
+typedef basic_waitable_timer<chrono::steady_clock> steady_timer;
+#elif defined(BOOST_ASIO_HAS_STD_CHRONO)
+# if defined(BOOST_ASIO_HAS_STD_CHRONO_MONOTONIC_CLOCK)
+typedef basic_waitable_timer<std::chrono::monotonic_clock> steady_timer;
+# else // defined(BOOST_ASIO_HAS_STD_CHRONO_MONOTONIC_CLOCK)
+typedef basic_waitable_timer<std::chrono::steady_clock> steady_timer;
+# endif // defined(BOOST_ASIO_HAS_STD_CHRONO_MONOTONIC_CLOCK)
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+typedef basic_waitable_timer<boost::chrono::steady_clock> steady_timer;
+#endif
+
+} // namespace asio
+} // namespace boost
+
+#endif // defined(BOOST_ASIO_HAS_STD_CHRONO)
+ // || defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_STEADY_TIMER_HPP
Modified: branches/release/boost/asio/strand.hpp
==============================================================================
--- branches/release/boost/asio/strand.hpp (original)
+++ branches/release/boost/asio/strand.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// strand.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/stream_socket_service.hpp
==============================================================================
--- branches/release/boost/asio/stream_socket_service.hpp (original)
+++ branches/release/boost/asio/stream_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/streambuf.hpp
==============================================================================
--- branches/release/boost/asio/streambuf.hpp (original)
+++ branches/release/boost/asio/streambuf.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// streambuf.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/system_timer.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/system_timer.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,59 @@
+//
+// system_timer.hpp
+// ~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_SYSTEM_TIMER_HPP
+#define BOOST_ASIO_SYSTEM_TIMER_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO) \
+ || defined(BOOST_ASIO_HAS_BOOST_CHRONO) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#if defined(BOOST_ASIO_HAS_STD_CHRONO)
+# include <chrono>
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+# include <boost/chrono/system_clocks.hpp>
+#endif
+
+#include <boost/asio/basic_waitable_timer.hpp>
+
+namespace boost {
+namespace asio {
+
+#if defined(GENERATING_DOCUMENTATION)
+/// Typedef for a timer based on the system clock.
+/**
+ * This typedef uses the C++11 @c <chrono> standard library facility, if
+ * available. Otherwise, it may use the Boost.Chrono library. To explicitly
+ * utilise Boost.Chrono, use the basic_waitable_timer template directly:
+ * @code
+ * typedef basic_waitable_timer<boost::chrono::system_clock> timer;
+ * @endcode
+ */
+typedef basic_waitable_timer<chrono::system_clock> system_timer;
+#elif defined(BOOST_ASIO_HAS_STD_CHRONO)
+typedef basic_waitable_timer<std::chrono::system_clock> system_timer;
+#elif defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+typedef basic_waitable_timer<boost::chrono::system_clock> system_timer;
+#endif
+
+} // namespace asio
+} // namespace boost
+
+#endif // defined(BOOST_ASIO_HAS_STD_CHRONO)
+ // || defined(BOOST_ASIO_HAS_BOOST_CHRONO)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_SYSTEM_TIMER_HPP
Modified: branches/release/boost/asio/time_traits.hpp
==============================================================================
--- branches/release/boost/asio/time_traits.hpp (original)
+++ branches/release/boost/asio/time_traits.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// time_traits.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/version.hpp
==============================================================================
--- branches/release/boost/asio/version.hpp (original)
+++ branches/release/boost/asio/version.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// version.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -18,6 +18,6 @@
// BOOST_ASIO_VERSION % 100 is the sub-minor version
// BOOST_ASIO_VERSION / 100 % 1000 is the minor version
// BOOST_ASIO_VERSION / 100000 is the major version
-#define BOOST_ASIO_VERSION 100601 // 1.6.1
+#define BOOST_ASIO_VERSION 100503 // 1.5.3
#endif // BOOST_ASIO_VERSION_HPP
Added: branches/release/boost/asio/wait_traits.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/wait_traits.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,43 @@
+//
+// wait_traits.hpp
+// ~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_WAIT_TRAITS_HPP
+#define BOOST_ASIO_WAIT_TRAITS_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+
+/// Wait traits suitable for use with the basic_waitable_timer class template.
+template <typename Clock>
+struct wait_traits
+{
+ /// Convert a clock duration into a duration used for waiting.
+ /**
+ * @returns @c d.
+ */
+ static typename Clock::duration to_wait_duration(
+ const typename Clock::duration& d)
+ {
+ return d;
+ }
+};
+
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_WAIT_TRAITS_HPP
Added: branches/release/boost/asio/waitable_timer_service.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/waitable_timer_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,161 @@
+//
+// waitable_timer_service.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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_WAITABLE_TIMER_SERVICE_HPP
+#define BOOST_ASIO_WAITABLE_TIMER_SERVICE_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+#include <cstddef>
+#include <boost/asio/detail/chrono_time_traits.hpp>
+#include <boost/asio/detail/deadline_timer_service.hpp>
+#include <boost/asio/io_service.hpp>
+#include <boost/asio/wait_traits.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+
+/// Default service implementation for a timer.
+template <typename Clock,
+ typename WaitTraits = boost::asio::wait_traits<Clock> >
+class waitable_timer_service
+#if defined(GENERATING_DOCUMENTATION)
+ : public boost::asio::io_service::service
+#else
+ : public boost::asio::detail::service_base<
+ waitable_timer_service<Clock, WaitTraits> >
+#endif
+{
+public:
+#if defined(GENERATING_DOCUMENTATION)
+ /// The unique service identifier.
+ static boost::asio::io_service::id id;
+#endif
+
+ /// The clock type.
+ typedef Clock clock_type;
+
+ /// The duration type of the clock.
+ typedef typename clock_type::duration duration;
+
+ /// The time point type of the clock.
+ typedef typename clock_type::time_point time_point;
+
+ /// The wait traits type.
+ typedef WaitTraits traits_type;
+
+private:
+ // The type of the platform-specific implementation.
+ typedef detail::deadline_timer_service<
+ detail::chrono_time_traits<Clock, WaitTraits> > service_impl_type;
+
+public:
+ /// The implementation type of the waitable timer.
+#if defined(GENERATING_DOCUMENTATION)
+ typedef implementation_defined implementation_type;
+#else
+ typedef typename service_impl_type::implementation_type implementation_type;
+#endif
+
+ /// Construct a new timer service for the specified io_service.
+ explicit waitable_timer_service(boost::asio::io_service& io_service)
+ : boost::asio::detail::service_base<
+ waitable_timer_service<Clock, WaitTraits> >(io_service),
+ service_impl_(io_service)
+ {
+ }
+
+ /// Construct a new timer implementation.
+ void construct(implementation_type& impl)
+ {
+ service_impl_.construct(impl);
+ }
+
+ /// Destroy a timer implementation.
+ void destroy(implementation_type& impl)
+ {
+ service_impl_.destroy(impl);
+ }
+
+ /// Cancel any asynchronous wait operations associated with the timer.
+ std::size_t cancel(implementation_type& impl, boost::system::error_code& ec)
+ {
+ return service_impl_.cancel(impl, ec);
+ }
+
+ /// Cancels one asynchronous wait operation associated with the timer.
+ std::size_t cancel_one(implementation_type& impl,
+ boost::system::error_code& ec)
+ {
+ return service_impl_.cancel_one(impl, ec);
+ }
+
+ /// Get the expiry time for the timer as an absolute time.
+ time_point expires_at(const implementation_type& impl) const
+ {
+ return service_impl_.expires_at(impl);
+ }
+
+ /// Set the expiry time for the timer as an absolute time.
+ std::size_t expires_at(implementation_type& impl,
+ const time_point& expiry_time, boost::system::error_code& ec)
+ {
+ return service_impl_.expires_at(impl, expiry_time, ec);
+ }
+
+ /// Get the expiry time for the timer relative to now.
+ duration expires_from_now(const implementation_type& impl) const
+ {
+ return service_impl_.expires_from_now(impl);
+ }
+
+ /// Set the expiry time for the timer relative to now.
+ std::size_t expires_from_now(implementation_type& impl,
+ const duration& expiry_time, boost::system::error_code& ec)
+ {
+ return service_impl_.expires_from_now(impl, expiry_time, ec);
+ }
+
+ // Perform a blocking wait on the timer.
+ void wait(implementation_type& impl, boost::system::error_code& ec)
+ {
+ service_impl_.wait(impl, ec);
+ }
+
+ // Start an asynchronous wait on the timer.
+ template <typename WaitHandler>
+ void async_wait(implementation_type& impl,
+ BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
+ {
+ service_impl_.async_wait(impl, BOOST_ASIO_MOVE_CAST(WaitHandler)(handler));
+ }
+
+private:
+ // Destroy all user-defined handler objects owned by the service.
+ void shutdown_service()
+ {
+ service_impl_.shutdown_service();
+ }
+
+ // The platform-specific implementation.
+ service_impl_type service_impl_;
+};
+
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // BOOST_ASIO_WAITABLE_TIMER_SERVICE_HPP
Modified: branches/release/boost/asio/windows/basic_handle.hpp
==============================================================================
--- branches/release/boost/asio/windows/basic_handle.hpp (original)
+++ branches/release/boost/asio/windows/basic_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/basic_handle.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -19,6 +19,7 @@
#if defined(BOOST_ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE) \
|| defined(BOOST_ASIO_HAS_WINDOWS_STREAM_HANDLE) \
+ || defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
|| defined(GENERATING_DOCUMENTATION)
#include <boost/asio/basic_io_object.hpp>
@@ -276,6 +277,7 @@
#endif // defined(BOOST_ASIO_HAS_WINDOWS_RANDOM_ACCESS_HANDLE)
// || defined(BOOST_ASIO_HAS_WINDOWS_STREAM_HANDLE)
+ // || defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
// || defined(GENERATING_DOCUMENTATION)
#endif // BOOST_ASIO_WINDOWS_BASIC_HANDLE_HPP
Added: branches/release/boost/asio/windows/basic_object_handle.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/windows/basic_object_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,177 @@
+//
+// windows/basic_object_handle.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2011 Boris Schaeling (boris_at_[hidden])
+//
+// 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_WINDOWS_BASIC_OBJECT_HANDLE_HPP
+#define BOOST_ASIO_WINDOWS_BASIC_OBJECT_HANDLE_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#include <boost/asio/detail/throw_error.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/windows/basic_handle.hpp>
+#include <boost/asio/windows/object_handle_service.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace windows {
+
+/// Provides object-oriented handle functionality.
+/**
+ * The windows::basic_object_handle class template provides asynchronous and
+ * blocking object-oriented handle functionality.
+ *
+ * @par Thread Safety
+ * @e Distinct @e objects: Safe._at_n
+ * @e Shared @e objects: Unsafe.
+ */
+template <typename ObjectHandleService = object_handle_service>
+class basic_object_handle
+ : public basic_handle<ObjectHandleService>
+{
+public:
+ /// The native representation of a handle.
+ typedef typename ObjectHandleService::native_handle_type native_handle_type;
+
+ /// Construct a basic_object_handle without opening it.
+ /**
+ * This constructor creates an object handle without opening it.
+ *
+ * @param io_service The io_service object that the object handle will use to
+ * dispatch handlers for any asynchronous operations performed on the handle.
+ */
+ explicit basic_object_handle(boost::asio::io_service& io_service)
+ : basic_handle<ObjectHandleService>(io_service)
+ {
+ }
+
+ /// Construct a basic_object_handle on an existing native handle.
+ /**
+ * This constructor creates an object handle object to hold an existing native
+ * handle.
+ *
+ * @param io_service The io_service object that the object handle will use to
+ * dispatch handlers for any asynchronous operations performed on the handle.
+ *
+ * @param native_handle The new underlying handle implementation.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ basic_object_handle(boost::asio::io_service& io_service,
+ const native_handle_type& native_handle)
+ : basic_handle<ObjectHandleService>(io_service, native_handle)
+ {
+ }
+
+#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+ /// Move-construct a basic_object_handle from another.
+ /**
+ * This constructor moves an object handle from one object to another.
+ *
+ * @param other The other basic_object_handle 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_object_handle(io_service&) constructor.
+ */
+ basic_object_handle(basic_object_handle&& other)
+ : basic_handle<ObjectHandleService>(
+ BOOST_ASIO_MOVE_CAST(basic_object_handle)(other))
+ {
+ }
+
+ /// Move-assign a basic_object_handle from another.
+ /**
+ * This assignment operator moves an object handle from one object to another.
+ *
+ * @param other The other basic_object_handle 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_object_handle(io_service&) constructor.
+ */
+ basic_object_handle& operator=(basic_object_handle&& other)
+ {
+ basic_handle<ObjectHandleService>::operator=(
+ BOOST_ASIO_MOVE_CAST(basic_object_handle)(other));
+ return *this;
+ }
+#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+
+ /// Perform a blocking wait on the object handle.
+ /**
+ * This function is used to wait for the object handle to be set to the
+ * signalled state. This function blocks and does not return until the object
+ * handle has been set to the signalled state.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ void wait()
+ {
+ boost::system::error_code ec;
+ this->service.wait(this->implementation, ec);
+ boost::asio::detail::throw_error(ec, "wait");
+ }
+
+ /// Perform a blocking wait on the object handle.
+ /**
+ * This function is used to wait for the object handle to be set to the
+ * signalled state. This function blocks and does not return until the object
+ * handle has been set to the signalled state.
+ *
+ * @param ec Set to indicate what error occurred, if any.
+ */
+ void wait(boost::system::error_code& ec)
+ {
+ this->service.wait(this->implementation, ec);
+ }
+
+ /// Start an asynchronous wait on the object handle.
+ /**
+ * This function is be used to initiate an asynchronous wait against the
+ * object handle. It always returns immediately.
+ *
+ * @param handler The handler to be called when the object handle is set to
+ * the signalled state. 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. Invocation
+ * of the handler will be performed in a manner equivalent to using
+ * boost::asio::io_service::post().
+ */
+ template <typename WaitHandler>
+ void async_wait(WaitHandler handler)
+ {
+ this->service.async_wait(this->implementation, handler);
+ }
+};
+
+} // namespace windows
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_WINDOWS_BASIC_OBJECT_HANDLE_HPP
Modified: branches/release/boost/asio/windows/basic_random_access_handle.hpp
==============================================================================
--- branches/release/boost/asio/windows/basic_random_access_handle.hpp (original)
+++ branches/release/boost/asio/windows/basic_random_access_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/basic_random_access_handle.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/windows/basic_stream_handle.hpp
==============================================================================
--- branches/release/boost/asio/windows/basic_stream_handle.hpp (original)
+++ branches/release/boost/asio/windows/basic_stream_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/basic_stream_handle.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/boost/asio/windows/object_handle.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/windows/object_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,40 @@
+//
+// windows/object_handle.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2011 Boris Schaeling (boris_at_[hidden])
+//
+// 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_WINDOWS_OBJECT_HANDLE_HPP
+#define BOOST_ASIO_WINDOWS_OBJECT_HANDLE_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#include <boost/asio/windows/basic_object_handle.hpp>
+
+namespace boost {
+namespace asio {
+namespace windows {
+
+/// Typedef for the typical usage of an object handle.
+typedef basic_object_handle<> object_handle;
+
+} // namespace windows
+} // namespace asio
+} // namespace boost
+
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_WINDOWS_OBJECT_HANDLE_HPP
Added: branches/release/boost/asio/windows/object_handle_service.hpp
==============================================================================
--- (empty file)
+++ branches/release/boost/asio/windows/object_handle_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,170 @@
+//
+// windows/object_handle_service.hpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2011 Boris Schaeling (boris_at_[hidden])
+//
+// 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_WINDOWS_OBJECT_HANDLE_SERVICE_HPP
+#define BOOST_ASIO_WINDOWS_OBJECT_HANDLE_SERVICE_HPP
+
+#if defined(_MSC_VER) && (_MSC_VER >= 1200)
+# pragma once
+#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
+
+#include <boost/asio/detail/config.hpp>
+
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE) \
+ || defined(GENERATING_DOCUMENTATION)
+
+#include <boost/asio/detail/win_object_handle_service.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/io_service.hpp>
+
+#include <boost/asio/detail/push_options.hpp>
+
+namespace boost {
+namespace asio {
+namespace windows {
+
+/// Default service implementation for an object handle.
+class object_handle_service
+#if defined(GENERATING_DOCUMENTATION)
+ : public boost::asio::io_service::service
+#else
+ : public boost::asio::detail::service_base<object_handle_service>
+#endif
+{
+public:
+#if defined(GENERATING_DOCUMENTATION)
+ /// The unique service identifier.
+ static boost::asio::io_service::id id;
+#endif
+
+private:
+ // The type of the platform-specific implementation.
+ typedef detail::win_object_handle_service service_impl_type;
+
+public:
+ /// The type of an object handle implementation.
+#if defined(GENERATING_DOCUMENTATION)
+ typedef implementation_defined implementation_type;
+#else
+ typedef service_impl_type::implementation_type implementation_type;
+#endif
+
+ /// The native handle type.
+#if defined(GENERATING_DOCUMENTATION)
+ typedef implementation_defined native_handle_type;
+#else
+ typedef service_impl_type::native_handle_type native_handle_type;
+#endif
+
+ /// Construct a new object handle service for the specified io_service.
+ explicit object_handle_service(boost::asio::io_service& io_service)
+ : boost::asio::detail::service_base<object_handle_service>(io_service),
+ service_impl_(io_service)
+ {
+ }
+
+ /// Construct a new object handle implementation.
+ void construct(implementation_type& impl)
+ {
+ service_impl_.construct(impl);
+ }
+
+#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+ /// Move-construct a new object handle implementation.
+ void move_construct(implementation_type& impl,
+ implementation_type& other_impl)
+ {
+ service_impl_.move_construct(impl, other_impl);
+ }
+
+ /// Move-assign from another object handle implementation.
+ void move_assign(implementation_type& impl,
+ object_handle_service& other_service,
+ implementation_type& other_impl)
+ {
+ service_impl_.move_assign(impl, other_service.service_impl_, other_impl);
+ }
+#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
+
+ /// Destroy an object handle implementation.
+ void destroy(implementation_type& impl)
+ {
+ service_impl_.destroy(impl);
+ }
+
+ /// Assign an existing native handle to an object handle.
+ boost::system::error_code assign(implementation_type& impl,
+ const native_handle_type& handle, boost::system::error_code& ec)
+ {
+ return service_impl_.assign(impl, handle, ec);
+ }
+
+ /// Determine whether the handle is open.
+ bool is_open(const implementation_type& impl) const
+ {
+ return service_impl_.is_open(impl);
+ }
+
+ /// Close an object handle implementation.
+ boost::system::error_code close(implementation_type& impl,
+ boost::system::error_code& ec)
+ {
+ return service_impl_.close(impl, ec);
+ }
+
+ /// Get the native handle implementation.
+ native_handle_type native_handle(implementation_type& impl)
+ {
+ return service_impl_.native_handle(impl);
+ }
+
+ /// Cancel all asynchronous operations associated with the handle.
+ boost::system::error_code cancel(implementation_type& impl,
+ boost::system::error_code& ec)
+ {
+ return service_impl_.cancel(impl, ec);
+ }
+
+ // Wait for a signaled state.
+ void wait(implementation_type& impl, boost::system::error_code& ec)
+ {
+ service_impl_.wait(impl, ec);
+ }
+
+ /// Start an asynchronous wait.
+ template <typename WaitHandler>
+ void async_wait(implementation_type& impl,
+ BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
+ {
+ service_impl_.async_wait(impl, BOOST_ASIO_MOVE_CAST(WaitHandler)(handler));
+ }
+
+private:
+ // Destroy all user-defined handler objects owned by the service.
+ void shutdown_service()
+ {
+ service_impl_.shutdown_service();
+ }
+
+ // The platform-specific implementation.
+ service_impl_type service_impl_;
+};
+
+} // namespace windows
+} // namespace asio
+} // namespace boost
+
+#include <boost/asio/detail/pop_options.hpp>
+
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+ // || defined(GENERATING_DOCUMENTATION)
+
+#endif // BOOST_ASIO_WINDOWS_OBJECT_HANDLE_SERVICE_HPP
Modified: branches/release/boost/asio/windows/overlapped_ptr.hpp
==============================================================================
--- branches/release/boost/asio/windows/overlapped_ptr.hpp (original)
+++ branches/release/boost/asio/windows/overlapped_ptr.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/overlapped_ptr.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/windows/random_access_handle.hpp
==============================================================================
--- branches/release/boost/asio/windows/random_access_handle.hpp (original)
+++ branches/release/boost/asio/windows/random_access_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/random_access_handle.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/windows/random_access_handle_service.hpp
==============================================================================
--- branches/release/boost/asio/windows/random_access_handle_service.hpp (original)
+++ branches/release/boost/asio/windows/random_access_handle_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/random_access_handle_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/windows/stream_handle.hpp
==============================================================================
--- branches/release/boost/asio/windows/stream_handle.hpp (original)
+++ branches/release/boost/asio/windows/stream_handle.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/stream_handle.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/windows/stream_handle_service.hpp
==============================================================================
--- branches/release/boost/asio/windows/stream_handle_service.hpp (original)
+++ branches/release/boost/asio/windows/stream_handle_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// windows/stream_handle_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/write.hpp
==============================================================================
--- branches/release/boost/asio/write.hpp (original)
+++ branches/release/boost/asio/write.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// write.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/boost/asio/write_at.hpp
==============================================================================
--- branches/release/boost/asio/write_at.hpp (original)
+++ branches/release/boost/asio/write_at.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// write_at.hpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/doc/Jamfile.v2 (original)
+++ branches/release/libs/asio/doc/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/asio.qbk
==============================================================================
--- branches/release/libs/asio/doc/asio.qbk (original)
+++ branches/release/libs/asio/doc/asio.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -7,7 +7,7 @@
[library Boost.Asio
[quickbook 1.4]
- [copyright 2003 - 2011 Christopher M. Kohlhoff]
+ [copyright 2003 - 2012 Christopher M. Kohlhoff]
[purpose Networking library]
[license
Distributed under the Boost Software License, Version 1.0.
Modified: branches/release/libs/asio/doc/doxy2qbk.pl
==============================================================================
--- branches/release/libs/asio/doc/doxy2qbk.pl (original)
+++ branches/release/libs/asio/doc/doxy2qbk.pl 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,6 +1,6 @@
#!/usr/bin/perl -w
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/examples.qbk
==============================================================================
--- branches/release/libs/asio/doc/examples.qbk (original)
+++ branches/release/libs/asio/doc/examples.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/history.qbk
==============================================================================
--- branches/release/libs/asio/doc/history.qbk (original)
+++ branches/release/libs/asio/doc/history.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -7,6 +7,29 @@
[section:history Revision History]
+[heading Asio 1.8.0 / Boost 1.49]
+
+* Added a new class template `basic_waitable_timer` based around the C++11 clock
+ type requirements. It may be used with the clocks from the C++11 `<chrono>`
+ library facility or, if those are not available, Boost.Chrono. The typedefs
+ `high_resolution_timer`, `steady_timer` and `system_timer` may be used to
+ create timer objects for the standard clock types.
+* Added a new `windows::object_handle` class for performing waits on Windows
+ kernel objects. Thanks go to Boris Schaeling for contributing substantially
+ to the development of this feature.
+* On Linux, `connect()` can return EAGAIN in certain circumstances. Remapped
+ this to another error so that it doesn't look like a non-blocking operation
+ ([@https://svn.boost.org/trac/boost/ticket/6048 #6048]).
+* Fixed a compile error on NetBSD
+ ([@https://svn.boost.org/trac/boost/ticket/6098 #6098]).
+* Fixed deadlock on Mac OS X
+ ([@https://svn.boost.org/trac/boost/ticket/6275 #6275]).
+* Fixed a regression in `buffered_write_stream`
+ ([@https://svn.boost.org/trac/boost/ticket/6310 #6310]).
+* Fixed a non-paged pool "leak" on Windows when an `io_service` is repeatedly
+ run without anything to do
+ ([@https://svn.boost.org/trac/boost/ticket/6321 #6321]).
+
[heading Asio 1.6.1 / Boost 1.48]
* Implemented various performance improvements, including:
Modified: branches/release/libs/asio/doc/index.xml
==============================================================================
--- branches/release/libs/asio/doc/index.xml (original)
+++ branches/release/libs/asio/doc/index.xml 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "../../../tools/boostbook/dtd/boostbook.dtd">
<!--
- Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/noncopyable_dox.txt
==============================================================================
--- branches/release/libs/asio/doc/noncopyable_dox.txt (original)
+++ branches/release/libs/asio/doc/noncopyable_dox.txt 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview.qbk (original)
+++ branches/release/libs/asio/doc/overview.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -33,6 +33,7 @@
* [link boost_asio.overview.windows Windows-Specific Functionality]
* [link boost_asio.overview.windows.stream_handle Stream-Oriented HANDLEs]
* [link boost_asio.overview.windows.random_access_handle Random-Access HANDLEs]
+ * [link boost_asio.overview.windows.object_handle Object HANDLEs]
* [link boost_asio.overview.ssl SSL]
* [link boost_asio.overview.cpp2011 C++ 2011 Support]
* [link boost_asio.overview.cpp2011.move_objects Movable I/O Objects]
@@ -41,6 +42,7 @@
* [link boost_asio.overview.cpp2011.array Array Container]
* [link boost_asio.overview.cpp2011.atomic Atomics]
* [link boost_asio.overview.cpp2011.shared_ptr Shared Pointers]
+ * [link boost_asio.overview.cpp2011.chrono Chrono]
* [link boost_asio.overview.implementation Platform-Specific Implementation Notes]
[include overview/rationale.qbk]
Modified: branches/release/libs/asio/doc/overview/allocation.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/allocation.qbk (original)
+++ branches/release/libs/asio/doc/overview/allocation.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/async.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/async.qbk (original)
+++ branches/release/libs/asio/doc/overview/async.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/basics.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/basics.qbk (original)
+++ branches/release/libs/asio/doc/overview/basics.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/bsd_sockets.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/bsd_sockets.qbk (original)
+++ branches/release/libs/asio/doc/overview/bsd_sockets.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/buffers.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/buffers.qbk (original)
+++ branches/release/libs/asio/doc/overview/buffers.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/cpp2011.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/cpp2011.qbk (original)
+++ branches/release/libs/asio/doc/overview/cpp2011.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -20,6 +20,8 @@
[link boost_asio.overview.cpp2011.shared_ptr Shared Pointers]
+[link boost_asio.overview.cpp2011.chrono Chrono]
+
[section:move_objects Movable I/O Objects]
@@ -191,4 +193,27 @@
[endsect]
+[section:chrono Chrono]
+
+Boost.Asio provides timers based on the `std::chrono` facilities via the [link
+boost_asio.reference.basic_waitable_timer basic_waitable_timer] class template.
+The typedefs [link boost_asio.reference.system_timer system_timer], [link
+boost_asio.reference.steady_timer steady_timer] and [link
+boost_asio.reference.high_resolution_timer high_resolution_timer] utilise the
+standard clocks `system_clock`, `steady_clock` and `high_resolution_clock`
+respectively.
+
+Support for the `std::chrono` facilities is automatically enabled for [^g++]
+4.6 and later, when the [^-std=c++0x] or [^-std=gnu++0x] compiler options are
+used. (Note that, for [^g++], the draft-standard `monotonic_clock` is used in
+place of `steady_clock`.) Support may be disabled by defining
+`BOOST_ASIO_DISABLE_STD_CHRONO`, or explicitly enabled for other compilers by
+defining `BOOST_ASIO_HAS_STD_CHRONO`.
+
+When standard `chrono` is unavailable, Boost.Asio will otherwise use the Boost.Chrono
+library. The [link boost_asio.reference.basic_waitable_timer basic_waitable_timer]
+class template may be used with either.
+
+[endsect]
+
[endsect]
Modified: branches/release/libs/asio/doc/overview/handler_tracking.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/handler_tracking.qbk (original)
+++ branches/release/libs/asio/doc/overview/handler_tracking.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/implementation.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/implementation.qbk (original)
+++ branches/release/libs/asio/doc/overview/implementation.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/iostreams.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/iostreams.qbk (original)
+++ branches/release/libs/asio/doc/overview/iostreams.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/line_based.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/line_based.qbk (original)
+++ branches/release/libs/asio/doc/overview/line_based.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/posix.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/posix.qbk (original)
+++ branches/release/libs/asio/doc/overview/posix.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/protocols.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/protocols.qbk (original)
+++ branches/release/libs/asio/doc/overview/protocols.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/rationale.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/rationale.qbk (original)
+++ branches/release/libs/asio/doc/overview/rationale.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/reactor.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/reactor.qbk (original)
+++ branches/release/libs/asio/doc/overview/reactor.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/serial_ports.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/serial_ports.qbk (original)
+++ branches/release/libs/asio/doc/overview/serial_ports.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/signals.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/signals.qbk (original)
+++ branches/release/libs/asio/doc/overview/signals.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/ssl.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/ssl.qbk (original)
+++ branches/release/libs/asio/doc/overview/ssl.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/strands.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/strands.qbk (original)
+++ branches/release/libs/asio/doc/overview/strands.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/streams.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/streams.qbk (original)
+++ branches/release/libs/asio/doc/overview/streams.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/threads.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/threads.qbk (original)
+++ branches/release/libs/asio/doc/overview/threads.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/timers.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/timers.qbk (original)
+++ branches/release/libs/asio/doc/overview/timers.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/overview/windows.qbk
==============================================================================
--- branches/release/libs/asio/doc/overview/windows.qbk (original)
+++ branches/release/libs/asio/doc/overview/windows.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -11,6 +11,8 @@
[link boost_asio.overview.windows.random_access_handle Random-Access HANDLEs]
+[link boost_asio.overview.windows.object_handle Object HANDLEs]
+
[section:stream_handle Stream-Oriented HANDLEs]
Boost.Asio contains classes to allow asynchronous read and write operations to be
@@ -88,4 +90,43 @@
[endsect]
+[/-----------------------------------------------------------------------------]
+
+[section:object_handle Object HANDLEs]
+
+Boost.Asio provides Windows-specific classes that permit asynchronous wait operations
+to be performed on HANDLEs to kernel objects of the following types:
+
+* Change notification
+* Console input
+* Event
+* Memory resource notification
+* Process
+* Semaphore
+* Thread
+* Waitable timer
+
+For example, to perform asynchronous operations on an event, the following
+object may be created:
+
+ HANDLE handle = ::CreateEvent(...);
+ windows::object_handle file(my_io_service, handle);
+
+The `wait()` and `async_wait()` member functions may then be used to wait until
+the kernel object is signalled.
+
+[heading See Also]
+
+[link boost_asio.reference.windows__object_handle windows::object_handle],
+[link boost_asio.reference.windows__basic_object_handle windows::basic_object_handle],
+[link boost_asio.reference.windows__object_handle_service windows::object_handle_service].
+
+[heading Notes]
+
+Windows object `HANDLE`s are only available at compile time when targeting
+Windows. Programs may test for the macro `BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE` to
+determine whether they are supported.
+
+[endsect]
+
[endsect]
Modified: branches/release/libs/asio/doc/quickref.xml
==============================================================================
--- branches/release/libs/asio/doc/quickref.xml (original)
+++ branches/release/libs/asio/doc/quickref.xml 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "../../../tools/boostbook/dtd/boostbook.dtd">
<!--
- Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ Copyright (c) 2003-2012 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)
@@ -282,21 +282,29 @@
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.deadline_timer">deadline_timer</link></member>
+ <member><link linkend="boost_asio.reference.high_resolution_timer">high_resolution_timer</link></member>
+ <member><link linkend="boost_asio.reference.steady_timer">steady_timer</link></member>
+ <member><link linkend="boost_asio.reference.system_timer">system_timer</link></member>
</simplelist>
<bridgehead renderas="sect3">Class Templates</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.basic_deadline_timer">basic_deadline_timer</link></member>
+ <member><link linkend="boost_asio.reference.basic_waitable_timer">basic_waitable_timer</link></member>
<member><link linkend="boost_asio.reference.time_traits_lt__ptime__gt_">time_traits</link></member>
+ <member><link linkend="boost_asio.reference.wait_traits">wait_traits</link></member>
</simplelist>
<bridgehead renderas="sect3">Services</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.deadline_timer_service">deadline_timer_service</link></member>
+ <member><link linkend="boost_asio.reference.waitable_timer_service">waitable_timer_service</link></member>
</simplelist>
<bridgehead renderas="sect3">Type Requirements</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.TimerService">TimerService</link></member>
<member><link linkend="boost_asio.reference.TimeTraits">TimeTraits</link></member>
+ <member><link linkend="boost_asio.reference.WaitableTimerService">WaitableTimerService</link></member>
<member><link linkend="boost_asio.reference.WaitHandler">WaitHandler</link></member>
+ <member><link linkend="boost_asio.reference.WaitTraits">WaitTraits</link></member>
</simplelist>
</entry>
<entry valign="top">
@@ -425,6 +433,7 @@
<entry valign="top" namest="c" nameend="d">
<bridgehead renderas="sect3">Classes</bridgehead>
<simplelist type="vert" columns="1">
+ <member><link linkend="boost_asio.reference.windows__object_handle">windows::object_handle</link></member>
<member><link linkend="boost_asio.reference.windows__overlapped_ptr">windows::overlapped_ptr</link></member>
<member><link linkend="boost_asio.reference.windows__random_access_handle">windows::random_access_handle</link></member>
<member><link linkend="boost_asio.reference.windows__stream_handle">windows::stream_handle</link></member>
@@ -432,17 +441,20 @@
<bridgehead renderas="sect3">Class Templates</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.windows__basic_handle">windows::basic_handle</link></member>
+ <member><link linkend="boost_asio.reference.windows__basic_object_handle">windows::basic_object_handle</link></member>
<member><link linkend="boost_asio.reference.windows__basic_random_access_handle">windows::basic_random_access_handle</link></member>
<member><link linkend="boost_asio.reference.windows__basic_stream_handle">windows::basic_stream_handle</link></member>
</simplelist>
<bridgehead renderas="sect3">Services</bridgehead>
<simplelist type="vert" columns="1">
+ <member><link linkend="boost_asio.reference.windows__object_handle_service">windows::object_handle_service</link></member>
<member><link linkend="boost_asio.reference.windows__random_access_handle_service">windows::random_access_handle_service</link></member>
<member><link linkend="boost_asio.reference.windows__stream_handle_service">windows::stream_handle_service</link></member>
</simplelist>
<bridgehead renderas="sect3">Type Requirements</bridgehead>
<simplelist type="vert" columns="1">
<member><link linkend="boost_asio.reference.HandleService">HandleService</link></member>
+ <member><link linkend="boost_asio.reference.ObjectHandleService">ObjectHandleService</link></member>
<member><link linkend="boost_asio.reference.RandomAccessHandleService">RandomAccessHandleService</link></member>
<member><link linkend="boost_asio.reference.StreamHandleService">StreamHandleService</link></member>
</simplelist>
Modified: branches/release/libs/asio/doc/reference.qbk
==============================================================================
--- branches/release/libs/asio/doc/reference.qbk (original)
+++ branches/release/libs/asio/doc/reference.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -33,6 +33,7 @@
[include requirements/IoControlCommand.qbk]
[include requirements/IoObjectService.qbk]
[include requirements/MutableBufferSequence.qbk]
+[include requirements/ObjectHandleService.qbk]
[include requirements/Protocol.qbk]
[include requirements/RandomAccessHandleService.qbk]
[include requirements/RawSocketService.qbk]
@@ -58,7 +59,9 @@
[include requirements/SyncWriteStream.qbk]
[include requirements/TimeTraits.qbk]
[include requirements/TimerService.qbk]
+[include requirements/WaitableTimerService.qbk]
[include requirements/WaitHandler.qbk]
+[include requirements/WaitTraits.qbk]
[include requirements/WriteHandler.qbk]
@@ -42945,400 +42948,386 @@
[endsect]
-[section:buffer buffer]
-
-[indexterm1 buffer]
-The `boost::asio::buffer` function is used to create a buffer object to represent raw memory, an array of POD elements, a vector of POD elements, or a std::string.
-
-
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload1 buffer]``(
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer.overload1 more...]]``
-
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload2 buffer]``(
- const mutable_buffer & b,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload2 more...]]``
-
- const_buffers_1 ``[link boost_asio.reference.buffer.overload3 buffer]``(
- const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer.overload3 more...]]``
-
- const_buffers_1 ``[link boost_asio.reference.buffer.overload4 buffer]``(
- const const_buffer & b,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload4 more...]]``
-
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload5 buffer]``(
- void * data,
- std::size_t size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload5 more...]]``
+[section:basic_waitable_timer basic_waitable_timer]
- const_buffers_1 ``[link boost_asio.reference.buffer.overload6 buffer]``(
- const void * data,
- std::size_t size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload6 more...]]``
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload7 buffer]``(
- PodType (&data)[N]);
- `` [''''»''' [link boost_asio.reference.buffer.overload7 more...]]``
+Provides waitable timer functionality.
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload8 buffer]``(
- PodType (&data)[N],
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload8 more...]]``
template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload9 buffer]``(
- const PodType (&data)[N]);
- `` [''''»''' [link boost_asio.reference.buffer.overload9 more...]]``
+ typename Clock,
+ typename ``[link boost_asio.reference.WaitTraits WaitTraits]`` = boost::asio::wait_traits<Clock>,
+ typename ``[link boost_asio.reference.WaitableTimerService WaitableTimerService]`` = waitable_timer_service<Clock, WaitTraits>>
+ class basic_waitable_timer :
+ public basic_io_object< WaitableTimerService >
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload10 buffer]``(
- const PodType (&data)[N],
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload10 more...]]``
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload11 buffer]``(
- boost::array< PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload11 more...]]``
+[heading Types]
+[table
+ [[Name][Description]]
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload12 buffer]``(
- boost::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload12 more...]]``
+ [
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload13 buffer]``(
- boost::array< const PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload13 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.clock_type [*clock_type]]]
+ [The clock type. ]
+
+ ]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload14 buffer]``(
- boost::array< const PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload14 more...]]``
+ [
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload15 buffer]``(
- const boost::array< PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload15 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.duration [*duration]]]
+ [The duration type of the clock. ]
+
+ ]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload16 buffer]``(
- const boost::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload16 more...]]``
+ [
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload17 buffer]``(
- std::array< PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload17 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload18 buffer]``(
- std::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload18 more...]]``
+ [
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload19 buffer]``(
- std::array< const PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload19 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload20 buffer]``(
- std::array< const PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload20 more...]]``
+ [
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload21 buffer]``(
- const std::array< PodType, N > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload21 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.time_point [*time_point]]]
+ [The time point type of the clock. ]
+
+ ]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload22 buffer]``(
- const std::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload22 more...]]``
+ [
- template<
- typename PodType,
- typename Allocator>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload23 buffer]``(
- std::vector< PodType, Allocator > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload23 more...]]``
+ [[link boost_asio.reference.basic_waitable_timer.traits_type [*traits_type]]]
+ [The wait traits type. ]
+
+ ]
- template<
- typename PodType,
- typename Allocator>
- mutable_buffers_1 ``[link boost_asio.reference.buffer.overload24 buffer]``(
- std::vector< PodType, Allocator > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload24 more...]]``
+]
- template<
- typename PodType,
- typename Allocator>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload25 buffer]``(
- const std::vector< PodType, Allocator > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload25 more...]]``
+[heading Member Functions]
+[table
+ [[Name][Description]]
- template<
- typename PodType,
- typename Allocator>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload26 buffer]``(
- const std::vector< PodType, Allocator > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload26 more...]]``
+ [
+ [[link boost_asio.reference.basic_waitable_timer.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer [*basic_waitable_timer]]]
+ [Constructor.
- template<
- typename Elem,
- typename Traits,
- typename Allocator>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload27 buffer]``(
- const std::basic_string< Elem, Traits, Allocator > & data);
- `` [''''»''' [link boost_asio.reference.buffer.overload27 more...]]``
+ Constructor to set a particular expiry time as an absolute time.
- template<
- typename Elem,
- typename Traits,
- typename Allocator>
- const_buffers_1 ``[link boost_asio.reference.buffer.overload28 buffer]``(
- const std::basic_string< Elem, Traits, Allocator > & data,
- std::size_t max_size_in_bytes);
- `` [''''»''' [link boost_asio.reference.buffer.overload28 more...]]``
+ Constructor to set a particular expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous operation that is waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_at [*expires_at]]]
+ [Get the timer's expiry time as an absolute time.
-A buffer object represents a contiguous region of memory as a 2-tuple consisting of a pointer and size in bytes. A tuple of the form `{void*, size_t}` specifies a mutable (modifiable) region of memory. Similarly, a tuple of the form `{const void*, size_t}` specifies a const (non-modifiable) region of memory. These two forms correspond to the classes [link boost_asio.reference.mutable_buffer `mutable_buffer`] and [link boost_asio.reference.const_buffer `const_buffer`], respectively. To mirror C++'s conversion rules, a [link boost_asio.reference.mutable_buffer `mutable_buffer`] is implicitly convertible to a [link boost_asio.reference.const_buffer `const_buffer`], and the opposite conversion is not permitted.
+ Set the timer's expiry time as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
-The simplest use case involves reading or writing a single buffer of a specified size:
+ Set the timer's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.wait [*wait]]]
+ [Perform a blocking wait on the timer. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
- sock.send(boost::asio::buffer(data, size));
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
-In the above example, the return value of `boost::asio::buffer` meets the requirements of the ConstBufferSequence concept so that it may be directly passed to the socket's write function. A buffer created for modifiable memory also meets the requirements of the MutableBufferSequence concept.
+The [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
-An individual buffer may be created from a builtin array, std::vector, std::array or boost::array of POD elements. This helps prevent buffer overruns by automatically determining the size of the buffer:
+A waitable timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
+Most applications will use the boost::asio::waitable\_timer typedef.
- char d1[128];
- size_t bytes_transferred = sock.receive(boost::asio::buffer(d1));
+[heading Remarks]
+
+This waitable timer functionality is for use with the C++11 standard library's `<chrono>` facility, or with the Boost.Chrono library.
- std::vector<char> d2(128);
- bytes_transferred = sock.receive(boost::asio::buffer(d2));
- std::array<char, 128> d3;
- bytes_transferred = sock.receive(boost::asio::buffer(d3));
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
- boost::array<char, 128> d4;
- bytes_transferred = sock.receive(boost::asio::buffer(d4));
+[*Shared] [*objects:] Unsafe.
+[heading Examples]
+
+Performing a blocking wait:
+ // Construct a timer without setting an expiry time.
+ boost::asio::waitable_timer timer(io_service);
-In all three cases above, the buffers created are exactly 128 bytes long. Note that a vector is [*never] automatically resized when creating or using a buffer. The buffer size is determined using the vector's `size()` member function, and not its capacity.
+ // Set an expiry time relative to now.
+ timer.expires_from_now(boost::posix_time::seconds(5));
+ // Wait for the timer to expire.
+ timer.wait();
-[heading Accessing Buffer Contents]
-
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+Performing an asynchronous wait:
- boost::asio::mutable_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
+ void handler(const boost::system::error_code& error)
+ {
+ if (!error)
+ {
+ // Timer expired.
+ }
+ }
- boost::asio::const_buffer b2 = ...;
- std::size_t s2 = boost::asio::buffer_size(b2);
- const void* p2 = boost::asio::buffer_cast<const void*>(b2);
+ ...
+ // Construct a timer with an absolute expiry time.
+ boost::asio::waitable_timer timer(io_service,
+ boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+ // Start an asynchronous wait.
+ timer.async_wait(handler);
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
-For convenience, the [link boost_asio.reference.buffer_size `buffer_size`] function also works on buffer sequences (that is, types meeting the ConstBufferSequence or MutableBufferSequence type requirements). In this case, the function returns the total size of all buffers in the sequence.
-[heading Buffer Copying]
+[heading Changing an active waitable_timer's expiry time]
-The [link boost_asio.reference.buffer_copy `buffer_copy`] function may be used to copy raw bytes between individual buffers and buffer sequences.
+Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
-In particular, when used with the [link boost_asio.reference.buffer_size `buffer_size`] , the [link boost_asio.reference.buffer_copy `buffer_copy`] function can be used to linearise a sequence of buffers. For example:
+ void on_some_event()
+ {
+ if (my_timer.expires_from_now(seconds(5)) > 0)
+ {
+ // We managed to cancel the timer. Start new asynchronous wait.
+ my_timer.async_wait(on_timeout);
+ }
+ else
+ {
+ // Too late, timer has already expired!
+ }
+ }
- vector<const_buffer> buffers = ...;
+ void on_timeout(const boost::system::error_code& e)
+ {
+ if (e != boost::asio::error::operation_aborted)
+ {
+ // Timer was not cancelled, take necessary action.
+ }
+ }
- vector<unsigned char> data(boost::asio::buffer_size(buffers));
- boost::asio::buffer_copy(boost::asio::buffer(data), buffers);
+* The `boost::asio::basic_waitable_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
-[heading Buffer Invalidation]
-
+* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
-A buffer object does not have any ownership of the memory it refers to. It is the responsibility of the application to ensure the memory region remains valid until it is no longer required for an I/O operation. When the memory is no longer available, the buffer is said to have been invalidated.
-For the `boost::asio::buffer` overloads that accept an argument of type std::vector, the buffer objects returned are invalidated by any vector operation that also invalidates all references, pointers and iterators referring to the elements in the sequence (C++ Std, 23.2.4)
-For the `boost::asio::buffer` overloads that accept an argument of type std::basic\_string, the buffer objects returned are invalidated according to the rules defined for invalidation of references, pointers and iterators referring to elements of the sequence (C++ Std, 21.3).
+[heading Requirements]
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
-[heading Buffer Arithmetic]
-
+[*Convenience header: ][^boost/asio.hpp]
-Buffer objects may be manipulated using simple arithmetic in a safe way which helps prevent buffer overruns. Consider an array initialised as follows:
+[section:async_wait basic_waitable_timer::async_wait]
+[indexterm2 async_wait..basic_waitable_timer]
+Start an asynchronous wait on the timer.
- boost::array<char, 6> a = { 'a', 'b', 'c', 'd', 'e' };
+ template<
+ typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
+ void async_wait(
+ WaitHandler handler);
+This function may be used to initiate an asynchronous wait against the timer. It always returns immediately.
+For each call to `async_wait()`, the supplied handler will be called exactly once. The handler will be called when:
-A buffer object `b1` created using:
+* The timer has expired.
- b1 = boost::asio::buffer(a);
+* The timer was cancelled, in which case the handler is passed the error code `boost::asio::error::operation_aborted`.
+[heading Parameters]
+
+[variablelist
+
+[[handler][The handler to be called when the timer expires. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error // Result of operation.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`. ]]
-represents the entire array, `{ 'a', 'b', 'c', 'd', 'e' }`. An optional second argument to the `boost::asio::buffer` function may be used to limit the size, in bytes, of the buffer:
+]
- b2 = boost::asio::buffer(a, 3);
+[endsect]
+[section:basic_waitable_timer basic_waitable_timer::basic_waitable_timer]
-such that `b2` represents the data `{ 'a', 'b', 'c' }`. Even if the size argument exceeds the actual size of the array, the size of the buffer object created will be limited to the array size.
+[indexterm2 basic_waitable_timer..basic_waitable_timer]
+Constructor.
-An offset may be applied to an existing buffer to create a new one:
+ explicit ``[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1 basic_waitable_timer]``(
+ boost::asio::io_service & io_service);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1 more...]]``
- b3 = b1 + 2;
+Constructor to set a particular expiry time as an absolute time.
+ ``[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2 basic_waitable_timer]``(
+ boost::asio::io_service & io_service,
+ const time_point & expiry_time);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2 more...]]``
-where `b3` will set to represent `{ 'c', 'd', 'e' }`. If the offset exceeds the size of the existing buffer, the newly created buffer will be empty.
+Constructor to set a particular expiry time relative to now.
-Both an offset and size may be specified to create a buffer that corresponds to a specific range of bytes within an existing buffer:
+ ``[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3 basic_waitable_timer]``(
+ boost::asio::io_service & io_service,
+ const duration & expiry_time);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3 more...]]``
- b4 = boost::asio::buffer(b1 + 1, 3);
+[section:overload1 basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)]
+Constructor.
-so that `b4` will refer to the bytes `{ 'b', 'c', 'd' }`.
+ basic_waitable_timer(
+ boost::asio::io_service & io_service);
-[heading Buffers and Scatter-Gather I/O]
-
+This constructor creates a timer without setting an expiry time. The `expires_at()` or `expires_from_now()` functions must be called to set an expiry time before the timer can be waited on.
-To read or write using multiple buffers (i.e. scatter-gather I/O), multiple buffer objects may be assigned into a container that supports the MutableBufferSequence (for read) or ConstBufferSequence (for write) concepts:
+[heading Parameters]
+
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer. ]]
+]
- char d1[128];
- std::vector<char> d2(128);
- boost::array<char, 128> d3;
- boost::array<mutable_buffer, 3> bufs1 = {
- boost::asio::buffer(d1),
- boost::asio::buffer(d2),
- boost::asio::buffer(d3) };
- bytes_transferred = sock.receive(bufs1);
- std::vector<const_buffer> bufs2;
- bufs2.push_back(boost::asio::buffer(d1));
- bufs2.push_back(boost::asio::buffer(d2));
- bufs2.push_back(boost::asio::buffer(d3));
- bytes_transferred = sock.send(bufs2);
+[endsect]
-[heading Requirements]
+[section:overload2 basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)]
-[*Header: ][^boost/asio/buffer.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+Constructor to set a particular expiry time as an absolute time.
-[section:overload1 buffer (1 of 28 overloads)]
+ basic_waitable_timer(
+ boost::asio::io_service & io_service,
+ const time_point & expiry_time);
-Create a new modifiable buffer from an existing buffer.
+This constructor creates a timer and sets the expiry time.
- mutable_buffers_1 buffer(
- const mutable_buffer & b);
+[heading Parameters]
+
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer.]]
+[[expiry_time][The expiry time to be used for the timer, expressed as an absolute time. ]]
-[heading Return Value]
-
-`mutable_buffers_1(b)`.
+]
@@ -43347,28 +43336,30 @@
-[section:overload2 buffer (2 of 28 overloads)]
+[section:overload3 basic_waitable_timer::basic_waitable_timer (3 of 3 overloads)]
-Create a new modifiable buffer from an existing buffer.
+Constructor to set a particular expiry time relative to now.
- mutable_buffers_1 buffer(
- const mutable_buffer & b,
- std::size_t max_size_in_bytes);
+ basic_waitable_timer(
+ boost::asio::io_service & io_service,
+ const duration & expiry_time);
+This constructor creates a timer and sets the expiry time.
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
- mutable_buffers_1(
- buffer_cast<void*>(b),
- min(buffer_size(b), max_size_in_bytes));
+[heading Parameters]
+
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the timer will use to dispatch handlers for any asynchronous operations performed on the timer.]]
+[[expiry_time][The expiry time to be used for the timer, relative to now. ]]
+]
@@ -43376,520 +43367,575 @@
[endsect]
+[endsect]
-[section:overload3 buffer (3 of 28 overloads)]
+[section:cancel basic_waitable_timer::cancel]
+[indexterm2 cancel..basic_waitable_timer]
+Cancel any asynchronous operations that are waiting on the timer.
-Create a new non-modifiable buffer from an existing buffer.
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.cancel.overload1 cancel]``();
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.cancel.overload1 more...]]``
- const_buffers_1 buffer(
- const const_buffer & b);
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.cancel.overload2 cancel]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.cancel.overload2 more...]]``
+[section:overload1 basic_waitable_timer::cancel (1 of 2 overloads)]
-[heading Return Value]
-
-`const_buffers_1(b)`.
+Cancel any asynchronous operations that are waiting on the timer.
+ std::size_t cancel();
-[endsect]
+This function forces the completion of any pending asynchronous wait operations against the timer. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+Cancelling the timer does not change the expiry time.
-[section:overload4 buffer (4 of 28 overloads)]
+[heading Return Value]
+
+The number of asynchronous operations that were cancelled.
-Create a new non-modifiable buffer from an existing buffer.
+[heading Exceptions]
+
- const_buffers_1 buffer(
- const const_buffer & b,
- std::size_t max_size_in_bytes);
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[heading Return Value]
+[heading Remarks]
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-
- const_buffers_1(
- buffer_cast<const void*>(b),
- min(buffer_size(b), max_size_in_bytes));
+If the timer has already expired when `cancel()` is called, then the handlers for asynchronous wait operations will:
+* have already been invoked; or
+* have been queued for invocation in the near future.
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
[endsect]
-[section:overload5 buffer (5 of 28 overloads)]
+[section:overload2 basic_waitable_timer::cancel (2 of 2 overloads)]
-Create a new modifiable buffer that represents the given memory range.
+Cancel any asynchronous operations that are waiting on the timer.
- mutable_buffers_1 buffer(
- void * data,
- std::size_t size_in_bytes);
+ std::size_t cancel(
+ boost::system::error_code & ec);
+This function forces the completion of any pending asynchronous wait operations against the timer. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
-[heading Return Value]
-
-`mutable_buffers_1(data, size_in_bytes)`.
-
+Cancelling the timer does not change the expiry time.
+[heading Parameters]
+
-[endsect]
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[section:overload6 buffer (6 of 28 overloads)]
+[heading Return Value]
+
+The number of asynchronous operations that were cancelled.
-Create a new non-modifiable buffer that represents the given memory range.
+[heading Remarks]
+
+If the timer has already expired when `cancel()` is called, then the handlers for asynchronous wait operations will:
- const_buffers_1 buffer(
- const void * data,
- std::size_t size_in_bytes);
+* have already been invoked; or
+* have been queued for invocation in the near future.
-[heading Return Value]
-
-`const_buffers_1(data, size_in_bytes)`.
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
+[endsect]
[endsect]
+[section:cancel_one basic_waitable_timer::cancel_one]
-
-[section:overload7 buffer (7 of 28 overloads)]
+[indexterm2 cancel_one..basic_waitable_timer]
+Cancels one asynchronous operation that is waiting on the timer.
-Create a new modifiable buffer that represents the given POD array.
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.cancel_one.overload1 cancel_one]``();
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.cancel_one.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.cancel_one.overload2 cancel_one]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.cancel_one.overload2 more...]]``
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- PodType (&data)[N]);
+[section:overload1 basic_waitable_timer::cancel_one (1 of 2 overloads)]
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+Cancels one asynchronous operation that is waiting on the timer.
- mutable_buffers_1(
- static_cast<void*>(data),
- N * sizeof(PodType));
+ std::size_t cancel_one();
+This function forces the completion of one pending asynchronous wait operation against the timer. Handlers are cancelled in FIFO order. The handler for the cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+Cancelling the timer does not change the expiry time.
+[heading Return Value]
+
+The number of asynchronous operations that were cancelled. That is, either 0 or 1.
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[section:overload8 buffer (8 of 28 overloads)]
+]
-Create a new modifiable buffer that represents the given POD array.
+[heading Remarks]
+
+If the timer has already expired when `cancel_one()` is called, then the handlers for asynchronous wait operations will:
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- PodType (&data)[N],
- std::size_t max_size_in_bytes);
+* have already been invoked; or
+* have been queued for invocation in the near future.
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
- mutable_buffers_1(
- static_cast<void*>(data),
- min(N * sizeof(PodType), max_size_in_bytes));
+[endsect]
+[section:overload2 basic_waitable_timer::cancel_one (2 of 2 overloads)]
+Cancels one asynchronous operation that is waiting on the timer.
-[endsect]
+ std::size_t cancel_one(
+ boost::system::error_code & ec);
-[section:overload9 buffer (9 of 28 overloads)]
+This function forces the completion of one pending asynchronous wait operation against the timer. Handlers are cancelled in FIFO order. The handler for the cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+Cancelling the timer does not change the expiry time.
-Create a new non-modifiable buffer that represents the given POD array.
+[heading Parameters]
+
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const PodType (&data)[N]);
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
+]
[heading Return Value]
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-
- const_buffers_1(
- static_cast<const void*>(data),
- N * sizeof(PodType));
+The number of asynchronous operations that were cancelled. That is, either 0 or 1.
+[heading Remarks]
+
+If the timer has already expired when `cancel_one()` is called, then the handlers for asynchronous wait operations will:
+* have already been invoked; or
+* have been queued for invocation in the near future.
-[endsect]
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
+[endsect]
-[section:overload10 buffer (10 of 28 overloads)]
+[endsect]
-Create a new non-modifiable buffer that represents the given POD array.
+[section:clock_type basic_waitable_timer::clock_type]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const PodType (&data)[N],
- std::size_t max_size_in_bytes);
+[indexterm2 clock_type..basic_waitable_timer]
+The clock type.
+ typedef Clock clock_type;
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- static_cast<const void*>(data),
- min(N * sizeof(PodType), max_size_in_bytes));
+[heading Requirements]
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[endsect]
+[section:duration basic_waitable_timer::duration]
+[indexterm2 duration..basic_waitable_timer]
+The duration type of the clock.
-[section:overload11 buffer (11 of 28 overloads)]
+ typedef clock_type::duration duration;
-Create a new modifiable buffer that represents the given POD array.
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- boost::array< PodType, N > & data);
+[heading Requirements]
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
- mutable_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+[endsect]
+[section:expires_at basic_waitable_timer::expires_at]
+[indexterm2 expires_at..basic_waitable_timer]
+Get the timer's expiry time as an absolute time.
+ time_point ``[link boost_asio.reference.basic_waitable_timer.expires_at.overload1 expires_at]``() const;
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_at.overload1 more...]]``
-[endsect]
+Set the timer's expiry time as an absolute time.
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.expires_at.overload2 expires_at]``(
+ const time_point & expiry_time);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_at.overload2 more...]]``
-[section:overload12 buffer (12 of 28 overloads)]
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.expires_at.overload3 expires_at]``(
+ const time_point & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_at.overload3 more...]]``
-Create a new modifiable buffer that represents the given POD array.
+[section:overload1 basic_waitable_timer::expires_at (1 of 3 overloads)]
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- boost::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
+Get the timer's expiry time as an absolute time.
+ time_point expires_at() const;
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
- mutable_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+This function may be used to obtain the timer's current expiry time. Whether the timer has expired or not does not affect this value.
+[endsect]
+[section:overload2 basic_waitable_timer::expires_at (2 of 3 overloads)]
-[endsect]
+Set the timer's expiry time as an absolute time.
+ std::size_t expires_at(
+ const time_point & expiry_time);
-[section:overload13 buffer (13 of 28 overloads)]
+This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
-Create a new non-modifiable buffer that represents the given POD array.
+[heading Parameters]
+
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- boost::array< const PodType, N > & data);
+[variablelist
+
+[[expiry_time][The expiry time to be used for the timer.]]
+]
[heading Return Value]
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+The number of asynchronous operations that were cancelled.
- const_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+
+[heading Exceptions]
+
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+
+]
+
+
+[heading Remarks]
+
+If the timer has already expired when `expires_at()` is called, then the handlers for asynchronous wait operations will:
+* have already been invoked; or
+* have been queued for invocation in the near future.
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
[endsect]
-[section:overload14 buffer (14 of 28 overloads)]
+[section:overload3 basic_waitable_timer::expires_at (3 of 3 overloads)]
-Create a new non-modifiable buffer that represents the given POD array.
+Set the timer's expiry time as an absolute time.
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- boost::array< const PodType, N > & data,
- std::size_t max_size_in_bytes);
+ std::size_t expires_at(
+ const time_point & expiry_time,
+ boost::system::error_code & ec);
+
+
+This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[expiry_time][The expiry time to be used for the timer.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
+]
[heading Return Value]
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+The number of asynchronous operations that were cancelled.
- const_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+[heading Remarks]
+
+If the timer has already expired when `expires_at()` is called, then the handlers for asynchronous wait operations will:
+* have already been invoked; or
+* have been queued for invocation in the near future.
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
[endsect]
+[endsect]
-[section:overload15 buffer (15 of 28 overloads)]
+[section:expires_from_now basic_waitable_timer::expires_from_now]
+[indexterm2 expires_from_now..basic_waitable_timer]
+Get the timer's expiry time relative to now.
-Create a new non-modifiable buffer that represents the given POD array.
+ duration ``[link boost_asio.reference.basic_waitable_timer.expires_from_now.overload1 expires_from_now]``() const;
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_from_now.overload1 more...]]``
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const boost::array< PodType, N > & data);
+Set the timer's expiry time relative to now.
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.expires_from_now.overload2 expires_from_now]``(
+ const duration & expiry_time);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_from_now.overload2 more...]]``
- const_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+ std::size_t ``[link boost_asio.reference.basic_waitable_timer.expires_from_now.overload3 expires_from_now]``(
+ const duration & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.expires_from_now.overload3 more...]]``
+[section:overload1 basic_waitable_timer::expires_from_now (1 of 3 overloads)]
+Get the timer's expiry time relative to now.
+ duration expires_from_now() const;
-[endsect]
+This function may be used to obtain the timer's current expiry time. Whether the timer has expired or not does not affect this value.
-[section:overload16 buffer (16 of 28 overloads)]
+[endsect]
-Create a new non-modifiable buffer that represents the given POD array.
+[section:overload2 basic_waitable_timer::expires_from_now (2 of 3 overloads)]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const boost::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
+Set the timer's expiry time relative to now.
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ std::size_t expires_from_now(
+ const duration & expiry_time);
- const_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+[heading Parameters]
+
+[variablelist
+
+[[expiry_time][The expiry time to be used for the timer.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of asynchronous operations that were cancelled.
+[heading Exceptions]
+
-[section:overload17 buffer (17 of 28 overloads)]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-Create a new modifiable buffer that represents the given POD array.
+[heading Remarks]
+
+If the timer has already expired when `expires_from_now()` is called, then the handlers for asynchronous wait operations will:
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- std::array< PodType, N > & data);
+* have already been invoked; or
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+* have been queued for invocation in the near future.
+
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
- mutable_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+[endsect]
+[section:overload3 basic_waitable_timer::expires_from_now (3 of 3 overloads)]
+Set the timer's expiry time relative to now.
-[endsect]
+ std::size_t expires_from_now(
+ const duration & expiry_time,
+ boost::system::error_code & ec);
-[section:overload18 buffer (18 of 28 overloads)]
+This function sets the expiry time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
-Create a new modifiable buffer that represents the given POD array.
+[heading Parameters]
+
+[variablelist
+
+[[expiry_time][The expiry time to be used for the timer.]]
- template<
- typename PodType,
- std::size_t N>
- mutable_buffers_1 buffer(
- std::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
+[[ec][Set to indicate what error occurred, if any.]]
+]
[heading Return Value]
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+The number of asynchronous operations that were cancelled.
- mutable_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+[heading Remarks]
+
+If the timer has already expired when `expires_from_now()` is called, then the handlers for asynchronous wait operations will:
+* have already been invoked; or
+* have been queued for invocation in the near future.
+These handlers can no longer be cancelled, and therefore are passed an error code that indicates the successful completion of the wait operation.
[endsect]
+[endsect]
-[section:overload19 buffer (19 of 28 overloads)]
+[section:get_implementation basic_waitable_timer::get_implementation]
+[indexterm2 get_implementation..basic_waitable_timer]
+Get the underlying implementation of the I/O object.
-Create a new non-modifiable buffer that represents the given POD array.
+ implementation_type & ``[link boost_asio.reference.basic_waitable_timer.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.get_implementation.overload1 more...]]``
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- std::array< const PodType, N > & data);
+ const implementation_type & ``[link boost_asio.reference.basic_waitable_timer.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.get_implementation.overload2 more...]]``
+[section:overload1 basic_waitable_timer::get_implementation (1 of 2 overloads)]
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+['Inherited from basic_io_object.]
+Get the underlying implementation of the I/O object.
+ implementation_type & get_implementation();
@@ -43897,171 +43943,156 @@
-[section:overload20 buffer (20 of 28 overloads)]
+[section:overload2 basic_waitable_timer::get_implementation (2 of 2 overloads)]
-Create a new non-modifiable buffer that represents the given POD array.
+['Inherited from basic_io_object.]
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- std::array< const PodType, N > & data,
- std::size_t max_size_in_bytes);
+Get the underlying implementation of the I/O object.
+ const implementation_type & get_implementation() const;
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+[endsect]
+[endsect]
+[section:get_io_service basic_waitable_timer::get_io_service]
-[endsect]
+['Inherited from basic_io_object.]
+[indexterm2 get_io_service..basic_waitable_timer]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
-[section:overload21 buffer (21 of 28 overloads)]
+ boost::asio::io_service & get_io_service();
-Create a new non-modifiable buffer that represents the given POD array.
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const std::array< PodType, N > & data);
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.data(),
- data.size() * sizeof(PodType));
+[endsect]
+[section:get_service basic_waitable_timer::get_service]
+[indexterm2 get_service..basic_waitable_timer]
+Get the service associated with the I/O object.
+ service_type & ``[link boost_asio.reference.basic_waitable_timer.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.get_service.overload1 more...]]``
+ const service_type & ``[link boost_asio.reference.basic_waitable_timer.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.get_service.overload2 more...]]``
-[endsect]
+[section:overload1 basic_waitable_timer::get_service (1 of 2 overloads)]
-[section:overload22 buffer (22 of 28 overloads)]
+['Inherited from basic_io_object.]
-Create a new non-modifiable buffer that represents the given POD array.
+Get the service associated with the I/O object.
- template<
- typename PodType,
- std::size_t N>
- const_buffers_1 buffer(
- const std::array< PodType, N > & data,
- std::size_t max_size_in_bytes);
+ service_type & get_service();
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+[endsect]
- const_buffers_1(
- data.data(),
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+[section:overload2 basic_waitable_timer::get_service (2 of 2 overloads)]
+
+
+['Inherited from basic_io_object.]
+
+
+Get the service associated with the I/O object.
+ const service_type & get_service() const;
[endsect]
+[endsect]
-[section:overload23 buffer (23 of 28 overloads)]
+[section:implementation basic_waitable_timer::implementation]
-Create a new modifiable buffer that represents the given POD vector.
+['Inherited from basic_io_object.]
- template<
- typename PodType,
- typename Allocator>
- mutable_buffers_1 buffer(
- std::vector< PodType, Allocator > & data);
+[indexterm2 implementation..basic_waitable_timer]
+(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
+ implementation_type implementation;
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
- mutable_buffers_1(
- data.size() ? &data[0] : 0,
- data.size() * sizeof(PodType));
+[endsect]
+[section:implementation_type basic_waitable_timer::implementation_type]
-[heading Remarks]
-
-The buffer is invalidated by any vector operation that would also invalidate iterators.
+['Inherited from basic_io_object.]
+[indexterm2 implementation_type..basic_waitable_timer]
+The underlying implementation type of I/O object.
-[endsect]
+ typedef service_type::implementation_type implementation_type;
-[section:overload24 buffer (24 of 28 overloads)]
+[heading Requirements]
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
-Create a new modifiable buffer that represents the given POD vector.
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename PodType,
- typename Allocator>
- mutable_buffers_1 buffer(
- std::vector< PodType, Allocator > & data,
- std::size_t max_size_in_bytes);
+[endsect]
-[heading Return Value]
-
-A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+[section:service basic_waitable_timer::service]
- mutable_buffers_1(
- data.size() ? &data[0] : 0,
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+
+['Inherited from basic_io_object.]
+
+[indexterm2 service..basic_waitable_timer]
+(Deprecated: Use `get_service()`.) The service associated with the I/O object.
+ service_type & service;
[heading Remarks]
-The buffer is invalidated by any vector operation that would also invalidate iterators.
+Available only for services that do not support movability.
@@ -44070,143 +44101,134 @@
-[section:overload25 buffer (25 of 28 overloads)]
+[section:service_type basic_waitable_timer::service_type]
-Create a new non-modifiable buffer that represents the given POD vector.
+['Inherited from basic_io_object.]
+[indexterm2 service_type..basic_waitable_timer]
+The type of the service that will be used to provide I/O operations.
- template<
- typename PodType,
- typename Allocator>
- const_buffers_1 buffer(
- const std::vector< PodType, Allocator > & data);
+ typedef WaitableTimerService service_type;
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.size() ? &data[0] : 0,
- data.size() * sizeof(PodType));
+[heading Requirements]
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[heading Remarks]
-
-The buffer is invalidated by any vector operation that would also invalidate iterators.
+[section:time_point basic_waitable_timer::time_point]
+[indexterm2 time_point..basic_waitable_timer]
+The time point type of the clock.
-[endsect]
+ typedef clock_type::time_point time_point;
-[section:overload26 buffer (26 of 28 overloads)]
+[heading Requirements]
-Create a new non-modifiable buffer that represents the given POD vector.
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename PodType,
- typename Allocator>
- const_buffers_1 buffer(
- const std::vector< PodType, Allocator > & data,
- std::size_t max_size_in_bytes);
+[endsect]
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.size() ? &data[0] : 0,
- min(data.size() * sizeof(PodType), max_size_in_bytes));
+[section:traits_type basic_waitable_timer::traits_type]
+[indexterm2 traits_type..basic_waitable_timer]
+The wait traits type.
+ typedef WaitTraits traits_type;
-[heading Remarks]
-
-The buffer is invalidated by any vector operation that would also invalidate iterators.
+[heading Requirements]
+
+[*Header: ][^boost/asio/basic_waitable_timer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:wait basic_waitable_timer::wait]
-[section:overload27 buffer (27 of 28 overloads)]
+[indexterm2 wait..basic_waitable_timer]
+Perform a blocking wait on the timer.
-Create a new non-modifiable buffer that represents the given string.
+ void ``[link boost_asio.reference.basic_waitable_timer.wait.overload1 wait]``();
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.wait.overload1 more...]]``
+ void ``[link boost_asio.reference.basic_waitable_timer.wait.overload2 wait]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.basic_waitable_timer.wait.overload2 more...]]``
- template<
- typename Elem,
- typename Traits,
- typename Allocator>
- const_buffers_1 buffer(
- const std::basic_string< Elem, Traits, Allocator > & data);
+[section:overload1 basic_waitable_timer::wait (1 of 2 overloads)]
-[heading Return Value]
-
-`const_buffers_1(data.data(), data.size() * sizeof(Elem))`.
+Perform a blocking wait on the timer.
-[heading Remarks]
-
-The buffer is invalidated by any non-const operation called on the given string object.
+ void wait();
+This function is used to wait for the timer to expire. This function blocks and does not return until the timer has expired.
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
-[section:overload28 buffer (28 of 28 overloads)]
-Create a new non-modifiable buffer that represents the given string.
+[endsect]
- template<
- typename Elem,
- typename Traits,
- typename Allocator>
- const_buffers_1 buffer(
- const std::basic_string< Elem, Traits, Allocator > & data,
- std::size_t max_size_in_bytes);
+[section:overload2 basic_waitable_timer::wait (2 of 2 overloads)]
-[heading Return Value]
-
-A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
- const_buffers_1(
- data.data(),
- min(data.size() * sizeof(Elem), max_size_in_bytes));
+Perform a blocking wait on the timer.
+ void wait(
+ boost::system::error_code & ec);
+This function is used to wait for the timer to expire. This function blocks and does not return until the timer has expired.
-[heading Remarks]
-
-The buffer is invalidated by any non-const operation called on the given string object.
+
+[heading Parameters]
+
+
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any. ]]
+
+]
@@ -44216,542 +44238,508 @@
[endsect]
-[section:buffer_cast buffer_cast]
-[indexterm1 buffer_cast]
-The `boost::asio::buffer_cast` function is used to obtain a pointer to the underlying memory region associated with a buffer.
+[endsect]
+
+[section:buffer buffer]
+
+[indexterm1 buffer]
+The `boost::asio::buffer` function is used to create a buffer object to represent raw memory, an array of POD elements, a vector of POD elements, or a std::string.
- template<
- typename PointerToPodType>
- PointerToPodType ``[link boost_asio.reference.buffer_cast.overload1 buffer_cast]``(
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload1 buffer]``(
const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer_cast.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffer.overload1 more...]]``
- template<
- typename PointerToPodType>
- PointerToPodType ``[link boost_asio.reference.buffer_cast.overload2 buffer_cast]``(
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload2 buffer]``(
+ const mutable_buffer & b,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload2 more...]]``
+
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload3 buffer]``(
const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer_cast.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffer.overload3 more...]]``
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload4 buffer]``(
+ const const_buffer & b,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload4 more...]]``
-[heading Examples:]
-
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload5 buffer]``(
+ void * data,
+ std::size_t size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload5 more...]]``
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload6 buffer]``(
+ const void * data,
+ std::size_t size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload6 more...]]``
-To access the memory of a non-modifiable buffer, use:
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload7 buffer]``(
+ PodType (&data)[N]);
+ `` [''''»''' [link boost_asio.reference.buffer.overload7 more...]]``
- boost::asio::const_buffer b1 = ...;
- const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload8 buffer]``(
+ PodType (&data)[N],
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload8 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload9 buffer]``(
+ const PodType (&data)[N]);
+ `` [''''»''' [link boost_asio.reference.buffer.overload9 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload10 buffer]``(
+ const PodType (&data)[N],
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload10 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload11 buffer]``(
+ boost::array< PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload11 more...]]``
-To access the memory of a modifiable buffer, use:
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload12 buffer]``(
+ boost::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload12 more...]]``
- boost::asio::mutable_buffer b2 = ...;
- unsigned char* p2 = boost::asio::buffer_cast<unsigned char*>(b2);
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload13 buffer]``(
+ boost::array< const PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload13 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload14 buffer]``(
+ boost::array< const PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload14 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload15 buffer]``(
+ const boost::array< PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload15 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload16 buffer]``(
+ const boost::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload16 more...]]``
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload17 buffer]``(
+ std::array< PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload17 more...]]``
-[heading Requirements]
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload18 buffer]``(
+ std::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload18 more...]]``
-[*Header: ][^boost/asio/buffer.hpp]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload19 buffer]``(
+ std::array< const PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload19 more...]]``
-[*Convenience header: ][^boost/asio.hpp]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload20 buffer]``(
+ std::array< const PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload20 more...]]``
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload21 buffer]``(
+ const std::array< PodType, N > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload21 more...]]``
-[section:overload1 buffer_cast (1 of 2 overloads)]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload22 buffer]``(
+ const std::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload22 more...]]``
+ template<
+ typename PodType,
+ typename Allocator>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload23 buffer]``(
+ std::vector< PodType, Allocator > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload23 more...]]``
-Cast a non-modifiable buffer to a specified pointer to POD type.
+ template<
+ typename PodType,
+ typename Allocator>
+ mutable_buffers_1 ``[link boost_asio.reference.buffer.overload24 buffer]``(
+ std::vector< PodType, Allocator > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload24 more...]]``
+ template<
+ typename PodType,
+ typename Allocator>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload25 buffer]``(
+ const std::vector< PodType, Allocator > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload25 more...]]``
template<
- typename PointerToPodType>
- PointerToPodType buffer_cast(
- const mutable_buffer & b);
+ typename PodType,
+ typename Allocator>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload26 buffer]``(
+ const std::vector< PodType, Allocator > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload26 more...]]``
+ template<
+ typename Elem,
+ typename Traits,
+ typename Allocator>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload27 buffer]``(
+ const std::basic_string< Elem, Traits, Allocator > & data);
+ `` [''''»''' [link boost_asio.reference.buffer.overload27 more...]]``
+ template<
+ typename Elem,
+ typename Traits,
+ typename Allocator>
+ const_buffers_1 ``[link boost_asio.reference.buffer.overload28 buffer]``(
+ const std::basic_string< Elem, Traits, Allocator > & data,
+ std::size_t max_size_in_bytes);
+ `` [''''»''' [link boost_asio.reference.buffer.overload28 more...]]``
-[endsect]
+A buffer object represents a contiguous region of memory as a 2-tuple consisting of a pointer and size in bytes. A tuple of the form `{void*, size_t}` specifies a mutable (modifiable) region of memory. Similarly, a tuple of the form `{const void*, size_t}` specifies a const (non-modifiable) region of memory. These two forms correspond to the classes [link boost_asio.reference.mutable_buffer `mutable_buffer`] and [link boost_asio.reference.const_buffer `const_buffer`], respectively. To mirror C++'s conversion rules, a [link boost_asio.reference.mutable_buffer `mutable_buffer`] is implicitly convertible to a [link boost_asio.reference.const_buffer `const_buffer`], and the opposite conversion is not permitted.
+The simplest use case involves reading or writing a single buffer of a specified size:
-[section:overload2 buffer_cast (2 of 2 overloads)]
+ sock.send(boost::asio::buffer(data, size));
-Cast a non-modifiable buffer to a specified pointer to POD type.
- template<
- typename PointerToPodType>
- PointerToPodType buffer_cast(
- const const_buffer & b);
+In the above example, the return value of `boost::asio::buffer` meets the requirements of the ConstBufferSequence concept so that it may be directly passed to the socket's write function. A buffer created for modifiable memory also meets the requirements of the MutableBufferSequence concept.
+An individual buffer may be created from a builtin array, std::vector, std::array or boost::array of POD elements. This helps prevent buffer overruns by automatically determining the size of the buffer:
-[endsect]
-[endsect]
+ char d1[128];
+ size_t bytes_transferred = sock.receive(boost::asio::buffer(d1));
-[section:buffer_copy buffer_copy]
+ std::vector<char> d2(128);
+ bytes_transferred = sock.receive(boost::asio::buffer(d2));
-[indexterm1 buffer_copy]
-The `boost::asio::buffer_copy` function is used to copy bytes from a source buffer (or buffer sequence) to a target buffer (or buffer sequence).
+ std::array<char, 128> d3;
+ bytes_transferred = sock.receive(boost::asio::buffer(d3));
-
- std::size_t ``[link boost_asio.reference.buffer_copy.overload1 buffer_copy]``(
- const mutable_buffer & target,
- const const_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload1 more...]]``
+ boost::array<char, 128> d4;
+ bytes_transferred = sock.receive(boost::asio::buffer(d4));
- std::size_t ``[link boost_asio.reference.buffer_copy.overload2 buffer_copy]``(
- const mutable_buffer & target,
- const const_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload2 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload3 buffer_copy]``(
- const mutable_buffer & target,
- const mutable_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload3 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload4 buffer_copy]``(
- const mutable_buffer & target,
- const mutable_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload4 more...]]``
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload5 buffer_copy]``(
- const mutable_buffer & target,
- const ConstBufferSequence & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload5 more...]]``
+In all three cases above, the buffers created are exactly 128 bytes long. Note that a vector is [*never] automatically resized when creating or using a buffer. The buffer size is determined using the vector's `size()` member function, and not its capacity.
- std::size_t ``[link boost_asio.reference.buffer_copy.overload6 buffer_copy]``(
- const mutable_buffers_1 & target,
- const const_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload6 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload7 buffer_copy]``(
- const mutable_buffers_1 & target,
- const const_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload7 more...]]``
+[heading Accessing Buffer Contents]
+
- std::size_t ``[link boost_asio.reference.buffer_copy.overload8 buffer_copy]``(
- const mutable_buffers_1 & target,
- const mutable_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload8 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload9 buffer_copy]``(
- const mutable_buffers_1 & target,
- const mutable_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload9 more...]]``
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload10 buffer_copy]``(
- const mutable_buffers_1 & target,
- const ConstBufferSequence & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload10 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload11 buffer_copy]``(
- const MutableBufferSequence & target,
- const const_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload11 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload12 buffer_copy]``(
- const MutableBufferSequence & target,
- const const_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload12 more...]]``
+ boost::asio::mutable_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload13 buffer_copy]``(
- const MutableBufferSequence & target,
- const mutable_buffer & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload13 more...]]``
+ boost::asio::const_buffer b2 = ...;
+ std::size_t s2 = boost::asio::buffer_size(b2);
+ const void* p2 = boost::asio::buffer_cast<const void*>(b2);
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload14 buffer_copy]``(
- const MutableBufferSequence & target,
- const mutable_buffers_1 & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload14 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload15 buffer_copy]``(
- const MutableBufferSequence & target,
- const ConstBufferSequence & source);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload15 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload16 buffer_copy]``(
- const mutable_buffer & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload16 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload17 buffer_copy]``(
- const mutable_buffer & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload17 more...]]``
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
- std::size_t ``[link boost_asio.reference.buffer_copy.overload18 buffer_copy]``(
- const mutable_buffer & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload18 more...]]``
+For convenience, the [link boost_asio.reference.buffer_size `buffer_size`] function also works on buffer sequences (that is, types meeting the ConstBufferSequence or MutableBufferSequence type requirements). In this case, the function returns the total size of all buffers in the sequence.
- std::size_t ``[link boost_asio.reference.buffer_copy.overload19 buffer_copy]``(
- const mutable_buffer & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload19 more...]]``
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload20 buffer_copy]``(
- const mutable_buffer & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload20 more...]]``
+[heading Buffer Copying]
+
- std::size_t ``[link boost_asio.reference.buffer_copy.overload21 buffer_copy]``(
- const mutable_buffers_1 & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload21 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_copy.overload22 buffer_copy]``(
- const mutable_buffers_1 & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload22 more...]]``
+The [link boost_asio.reference.buffer_copy `buffer_copy`] function may be used to copy raw bytes between individual buffers and buffer sequences.
- std::size_t ``[link boost_asio.reference.buffer_copy.overload23 buffer_copy]``(
- const mutable_buffers_1 & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload23 more...]]``
+In particular, when used with the [link boost_asio.reference.buffer_size `buffer_size`] , the [link boost_asio.reference.buffer_copy `buffer_copy`] function can be used to linearise a sequence of buffers. For example:
- std::size_t ``[link boost_asio.reference.buffer_copy.overload24 buffer_copy]``(
- const mutable_buffers_1 & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload24 more...]]``
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload25 buffer_copy]``(
- const mutable_buffers_1 & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload25 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload26 buffer_copy]``(
- const MutableBufferSequence & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload26 more...]]``
+ vector<const_buffer> buffers = ...;
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload27 buffer_copy]``(
- const MutableBufferSequence & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload27 more...]]``
+ vector<unsigned char> data(boost::asio::buffer_size(buffers));
+ boost::asio::buffer_copy(boost::asio::buffer(data), buffers);
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload28 buffer_copy]``(
- const MutableBufferSequence & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload28 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload29 buffer_copy]``(
- const MutableBufferSequence & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload29 more...]]``
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffer_copy.overload30 buffer_copy]``(
- const MutableBufferSequence & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
- `` [''''»''' [link boost_asio.reference.buffer_copy.overload30 more...]]``
-The `buffer_copy` function is available in two forms:
+[heading Buffer Invalidation]
+
-* A 2-argument form: `buffer_copy(target, source)`
+A buffer object does not have any ownership of the memory it refers to. It is the responsibility of the application to ensure the memory region remains valid until it is no longer required for an I/O operation. When the memory is no longer available, the buffer is said to have been invalidated.
-* A 3-argument form: `buffer_copy(target, source, max_bytes_to_copy)`
+For the `boost::asio::buffer` overloads that accept an argument of type std::vector, the buffer objects returned are invalidated by any vector operation that also invalidates all references, pointers and iterators referring to the elements in the sequence (C++ Std, 23.2.4)
-Both forms return the number of bytes actually copied. The number of bytes copied is the lesser of:
+For the `boost::asio::buffer` overloads that accept an argument of type std::basic\_string, the buffer objects returned are invalidated according to the rules defined for invalidation of references, pointers and iterators referring to elements of the sequence (C++ Std, 21.3).
-* `buffer_size(target)`
+[heading Buffer Arithmetic]
+
-* `buffer_size(source)`
+Buffer objects may be manipulated using simple arithmetic in a safe way which helps prevent buffer overruns. Consider an array initialised as follows:
-* `If` specified, `max_bytes_to_copy`.
-This prevents buffer overflow, regardless of the buffer sizes used in the copy operation.
+ boost::array<char, 6> a = { 'a', 'b', 'c', 'd', 'e' };
-[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+A buffer object `b1` created using:
-[section:overload1 buffer_copy (1 of 30 overloads)]
-Copies bytes from a source buffer to a target buffer.
+ b1 = boost::asio::buffer(a);
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const const_buffer & source);
+represents the entire array, `{ 'a', 'b', 'c', 'd', 'e' }`. An optional second argument to the `boost::asio::buffer` function may be used to limit the size, in bytes, of the buffer:
-[heading Parameters]
-
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-]
+ b2 = boost::asio::buffer(a, 3);
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+such that `b2` represents the data `{ 'a', 'b', 'c' }`. Even if the size argument exceeds the actual size of the array, the size of the buffer object created will be limited to the array size.
-* `buffer_size(target)`
+An offset may be applied to an existing buffer to create a new one:
-* `buffer_size(source)`
+ b3 = b1 + 2;
-[endsect]
+where `b3` will set to represent `{ 'c', 'd', 'e' }`. If the offset exceeds the size of the existing buffer, the newly created buffer will be empty.
+Both an offset and size may be specified to create a buffer that corresponds to a specific range of bytes within an existing buffer:
-[section:overload2 buffer_copy (2 of 30 overloads)]
-Copies bytes from a source buffer to a target buffer.
+ b4 = boost::asio::buffer(b1 + 1, 3);
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const const_buffers_1 & source);
+so that `b4` will refer to the bytes `{ 'b', 'c', 'd' }`.
-[heading Parameters]
-
-[variablelist
+[heading Buffers and Scatter-Gather I/O]
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-]
+To read or write using multiple buffers (i.e. scatter-gather I/O), multiple buffer objects may be assigned into a container that supports the MutableBufferSequence (for read) or ConstBufferSequence (for write) concepts:
-[heading Return Value]
-
-The number of bytes copied.
+ char d1[128];
+ std::vector<char> d2(128);
+ boost::array<char, 128> d3;
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+ boost::array<mutable_buffer, 3> bufs1 = {
+ boost::asio::buffer(d1),
+ boost::asio::buffer(d2),
+ boost::asio::buffer(d3) };
+ bytes_transferred = sock.receive(bufs1);
+ std::vector<const_buffer> bufs2;
+ bufs2.push_back(boost::asio::buffer(d1));
+ bufs2.push_back(boost::asio::buffer(d2));
+ bufs2.push_back(boost::asio::buffer(d3));
+ bytes_transferred = sock.send(bufs2);
-* `buffer_size(target)`
-* `buffer_size(source)`
+[heading Requirements]
+[*Header: ][^boost/asio/buffer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:overload1 buffer (1 of 28 overloads)]
-[section:overload3 buffer_copy (3 of 30 overloads)]
+Create a new modifiable buffer from an existing buffer.
-Copies bytes from a source buffer to a target buffer.
+ mutable_buffers_1 buffer(
+ const mutable_buffer & b);
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const mutable_buffer & source);
+[heading Return Value]
+
+`mutable_buffers_1(b)`.
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes copied.
+[section:overload2 buffer (2 of 28 overloads)]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+Create a new modifiable buffer from an existing buffer.
-* `buffer_size(target)`
+ mutable_buffers_1 buffer(
+ const mutable_buffer & b,
+ std::size_t max_size_in_bytes);
-* `buffer_size(source)`
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ buffer_cast<void*>(b),
+ min(buffer_size(b), max_size_in_bytes));
-[endsect]
-[section:overload4 buffer_copy (4 of 30 overloads)]
-Copies bytes from a source buffer to a target buffer.
+[endsect]
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const mutable_buffers_1 & source);
+[section:overload3 buffer (3 of 28 overloads)]
-[heading Parameters]
-
+Create a new non-modifiable buffer from an existing buffer.
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+ const_buffers_1 buffer(
+ const const_buffer & b);
-]
[heading Return Value]
-The number of bytes copied.
+`const_buffers_1(b)`.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-* `buffer_size(target)`
+[endsect]
-* `buffer_size(source)`
+[section:overload4 buffer (4 of 28 overloads)]
+Create a new non-modifiable buffer from an existing buffer.
-[endsect]
+ const_buffers_1 buffer(
+ const const_buffer & b,
+ std::size_t max_size_in_bytes);
-[section:overload5 buffer_copy (5 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-Copies bytes from a source buffer sequence to a target buffer.
+ const_buffers_1(
+ buffer_cast<const void*>(b),
+ min(buffer_size(b), max_size_in_bytes));
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const ConstBufferSequence & source);
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes copied.
+[section:overload5 buffer (5 of 28 overloads)]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+Create a new modifiable buffer that represents the given memory range.
-* `buffer_size(target)`
+ mutable_buffers_1 buffer(
+ void * data,
+ std::size_t size_in_bytes);
-* `buffer_size(source)`
+
+[heading Return Value]
+
+`mutable_buffers_1(data, size_in_bytes)`.
@@ -44760,90 +44748,86 @@
-[section:overload6 buffer_copy (6 of 30 overloads)]
+[section:overload6 buffer (6 of 28 overloads)]
-Copies bytes from a source buffer to a target buffer.
+Create a new non-modifiable buffer that represents the given memory range.
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const const_buffer & source);
+ const_buffers_1 buffer(
+ const void * data,
+ std::size_t size_in_bytes);
-[heading Parameters]
-
+[heading Return Value]
+
+`const_buffers_1(data, size_in_bytes)`.
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+[section:overload7 buffer (7 of 28 overloads)]
-* `buffer_size(target)`
+Create a new modifiable buffer that represents the given POD array.
-* `buffer_size(source)`
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ PodType (&data)[N]);
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
-[endsect]
+ mutable_buffers_1(
+ static_cast<void*>(data),
+ N * sizeof(PodType));
-[section:overload7 buffer_copy (7 of 30 overloads)]
-Copies bytes from a source buffer to a target buffer.
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const const_buffers_1 & source);
+[endsect]
-[heading Parameters]
-
+[section:overload8 buffer (8 of 28 overloads)]
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
+Create a new modifiable buffer that represents the given POD array.
-]
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ PodType (&data)[N],
+ std::size_t max_size_in_bytes);
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
+[heading Return Value]
-The number of bytes copied is the lesser of:
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ static_cast<void*>(data),
+ min(N * sizeof(PodType), max_size_in_bytes));
-* `buffer_size(target)`
-* `buffer_size(source)`
@@ -44852,138 +44836,128 @@
-[section:overload8 buffer_copy (8 of 30 overloads)]
-
+[section:overload9 buffer (9 of 28 overloads)]
-Copies bytes from a source buffer to a target buffer.
+Create a new non-modifiable buffer that represents the given POD array.
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const mutable_buffer & source);
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const PodType (&data)[N]);
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+ const_buffers_1(
+ static_cast<const void*>(data),
+ N * sizeof(PodType));
-]
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-* `buffer_size(target)`
+[endsect]
-* `buffer_size(source)`
+[section:overload10 buffer (10 of 28 overloads)]
+Create a new non-modifiable buffer that represents the given POD array.
-[endsect]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const PodType (&data)[N],
+ std::size_t max_size_in_bytes);
-[section:overload9 buffer_copy (9 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-Copies bytes from a source buffer to a target buffer.
+ const_buffers_1(
+ static_cast<const void*>(data),
+ min(N * sizeof(PodType), max_size_in_bytes));
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const mutable_buffers_1 & source);
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes copied.
+[section:overload11 buffer (11 of 28 overloads)]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+Create a new modifiable buffer that represents the given POD array.
-* `buffer_size(target)`
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ boost::array< PodType, N > & data);
-* `buffer_size(source)`
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-[endsect]
-[section:overload10 buffer_copy (10 of 30 overloads)]
-Copies bytes from a source buffer sequence to a target buffer.
+[endsect]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const ConstBufferSequence & source);
+[section:overload12 buffer (12 of 28 overloads)]
-[heading Parameters]
-
+Create a new modifiable buffer that represents the given POD array.
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ boost::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-* `buffer_size(target)`
-* `buffer_size(source)`
@@ -44992,94 +44966,95 @@
-[section:overload11 buffer_copy (11 of 30 overloads)]
+[section:overload13 buffer (13 of 28 overloads)]
-Copies bytes from a source buffer to a target buffer sequence.
+Create a new non-modifiable buffer that represents the given POD array.
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const const_buffer & source);
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ boost::array< const PodType, N > & data);
-[heading Parameters]
-
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-[variablelist
-
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+ const_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-]
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+[endsect]
-* `buffer_size(target)`
-* `buffer_size(source)`
+[section:overload14 buffer (14 of 28 overloads)]
+Create a new non-modifiable buffer that represents the given POD array.
-[endsect]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ boost::array< const PodType, N > & data,
+ std::size_t max_size_in_bytes);
-[section:overload12 buffer_copy (12 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-Copies bytes from a source buffer to a target buffer sequence.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const const_buffers_1 & source);
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[endsect]
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-]
+[section:overload15 buffer (15 of 28 overloads)]
-[heading Return Value]
-
-The number of bytes copied.
+
+Create a new non-modifiable buffer that represents the given POD array.
-[heading Remarks]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const boost::array< PodType, N > & data);
+
+
+
+[heading Return Value]
-The number of bytes copied is the lesser of:
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-* `buffer_size(target)`
-* `buffer_size(source)`
@@ -45088,143 +45063,128 @@
-[section:overload13 buffer_copy (13 of 30 overloads)]
+[section:overload16 buffer (16 of 28 overloads)]
-Copies bytes from a source buffer to a target buffer sequence.
+Create a new non-modifiable buffer that represents the given POD array.
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const mutable_buffer & source);
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const boost::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
-[heading Parameters]
-
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-[variablelist
-
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+ const_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-]
-[heading Return Value]
-
-The number of bytes copied.
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+[endsect]
-* `buffer_size(target)`
-* `buffer_size(source)`
+[section:overload17 buffer (17 of 28 overloads)]
+Create a new modifiable buffer that represents the given POD array.
-[endsect]
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ std::array< PodType, N > & data);
-[section:overload14 buffer_copy (14 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-Copies bytes from a source buffer to a target buffer sequence.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const mutable_buffers_1 & source);
-[heading Parameters]
-
-
-[variablelist
-
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes copied.
+[section:overload18 buffer (18 of 28 overloads)]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+Create a new modifiable buffer that represents the given POD array.
-* `buffer_size(target)`
+ template<
+ typename PodType,
+ std::size_t N>
+ mutable_buffers_1 buffer(
+ std::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
-* `buffer_size(source)`
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-[endsect]
-[section:overload15 buffer_copy (15 of 30 overloads)]
-Copies bytes from a source buffer sequence to a target buffer sequence.
+[endsect]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const ConstBufferSequence & source);
+[section:overload19 buffer (19 of 28 overloads)]
-[heading Parameters]
-
+Create a new non-modifiable buffer that represents the given POD array.
-[variablelist
-
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
-[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ std::array< const PodType, N > & data);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-* `buffer_size(target)`
-* `buffer_size(source)`
@@ -45233,50 +45193,31 @@
-[section:overload16 buffer_copy (16 of 30 overloads)]
-
-
-Copies a limited number of bytes from a source buffer to a target buffer.
-
-
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
-
-
+[section:overload20 buffer (20 of 28 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+Create a new non-modifiable buffer that represents the given POD array.
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ std::array< const PodType, N > & data,
+ std::size_t max_size_in_bytes);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-
-
-* `buffer_size(target)`
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-* `buffer_size(source)`
-* `max_bytes_to_copy`
@@ -45285,50 +45226,30 @@
-[section:overload17 buffer_copy (17 of 30 overloads)]
-
-
-Copies a limited number of bytes from a source buffer to a target buffer.
-
-
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
-
-
+[section:overload21 buffer (21 of 28 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+Create a new non-modifiable buffer that represents the given POD array.
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const std::array< PodType, N > & data);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-
-
-* `buffer_size(target)`
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ data.size() * sizeof(PodType));
-* `buffer_size(source)`
-* `max_bytes_to_copy`
@@ -45337,50 +45258,31 @@
-[section:overload18 buffer_copy (18 of 30 overloads)]
-
-
-Copies a limited number of bytes from a source buffer to a target buffer.
-
-
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
-
-
+[section:overload22 buffer (22 of 28 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+Create a new non-modifiable buffer that represents the given POD array.
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename PodType,
+ std::size_t N>
+ const_buffers_1 buffer(
+ const std::array< PodType, N > & data,
+ std::size_t max_size_in_bytes);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-
-
-* `buffer_size(target)`
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-* `buffer_size(source)`
-* `max_bytes_to_copy`
@@ -45389,50 +45291,35 @@
-[section:overload19 buffer_copy (19 of 30 overloads)]
-
-
-Copies a limited number of bytes from a source buffer to a target buffer.
-
-
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
-
-
+[section:overload23 buffer (23 of 28 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+Create a new modifiable buffer that represents the given POD vector.
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename PodType,
+ typename Allocator>
+ mutable_buffers_1 buffer(
+ std::vector< PodType, Allocator > & data);
-]
[heading Return Value]
-The number of bytes copied.
-
-
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
+ mutable_buffers_1(
+ data.size() ? &data[0] : 0,
+ data.size() * sizeof(PodType));
-* `buffer_size(target)`
-* `buffer_size(source)`
-* `max_bytes_to_copy`
+[heading Remarks]
+
+The buffer is invalidated by any vector operation that would also invalidate iterators.
@@ -45441,305 +45328,483 @@
-[section:overload20 buffer_copy (20 of 30 overloads)]
+[section:overload24 buffer (24 of 28 overloads)]
-Copies a limited number of bytes from a source buffer sequence to a target buffer.
+Create a new modifiable buffer that represents the given POD vector.
template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t buffer_copy(
- const mutable_buffer & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
-
-
+ typename PodType,
+ typename Allocator>
+ mutable_buffers_1 buffer(
+ std::vector< PodType, Allocator > & data,
+ std::size_t max_size_in_bytes);
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+[heading Return Value]
+
+A [link boost_asio.reference.mutable_buffers_1 `mutable_buffers_1`] value equivalent to:
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ mutable_buffers_1(
+ data.size() ? &data[0] : 0,
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-]
-[heading Return Value]
-
-The number of bytes copied.
[heading Remarks]
-The number of bytes copied is the lesser of:
+The buffer is invalidated by any vector operation that would also invalidate iterators.
-* `buffer_size(target)`
-* `buffer_size(source)`
+[endsect]
-* `max_bytes_to_copy`
+[section:overload25 buffer (25 of 28 overloads)]
+Create a new non-modifiable buffer that represents the given POD vector.
-[endsect]
+ template<
+ typename PodType,
+ typename Allocator>
+ const_buffers_1 buffer(
+ const std::vector< PodType, Allocator > & data);
-[section:overload21 buffer_copy (21 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-Copies a limited number of bytes from a source buffer to a target buffer.
+ const_buffers_1(
+ data.size() ? &data[0] : 0,
+ data.size() * sizeof(PodType));
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
-[heading Parameters]
-
+[heading Remarks]
+
+The buffer is invalidated by any vector operation that would also invalidate iterators.
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes copied.
+[section:overload26 buffer (26 of 28 overloads)]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+Create a new non-modifiable buffer that represents the given POD vector.
-* `buffer_size(target)`
+ template<
+ typename PodType,
+ typename Allocator>
+ const_buffers_1 buffer(
+ const std::vector< PodType, Allocator > & data,
+ std::size_t max_size_in_bytes);
-* `buffer_size(source)`
-* `max_bytes_to_copy`
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
+ const_buffers_1(
+ data.size() ? &data[0] : 0,
+ min(data.size() * sizeof(PodType), max_size_in_bytes));
-[endsect]
+[heading Remarks]
+
+The buffer is invalidated by any vector operation that would also invalidate iterators.
-[section:overload22 buffer_copy (22 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer.
+[endsect]
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
+[section:overload27 buffer (27 of 28 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+Create a new non-modifiable buffer that represents the given string.
-[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename Elem,
+ typename Traits,
+ typename Allocator>
+ const_buffers_1 buffer(
+ const std::basic_string< Elem, Traits, Allocator > & data);
-]
[heading Return Value]
-The number of bytes copied.
+`const_buffers_1(data.data(), data.size() * sizeof(Elem))`.
[heading Remarks]
-The number of bytes copied is the lesser of:
+The buffer is invalidated by any non-const operation called on the given string object.
-* `buffer_size(target)`
-* `buffer_size(source)`
+[endsect]
-* `max_bytes_to_copy`
+[section:overload28 buffer (28 of 28 overloads)]
+Create a new non-modifiable buffer that represents the given string.
-[endsect]
+ template<
+ typename Elem,
+ typename Traits,
+ typename Allocator>
+ const_buffers_1 buffer(
+ const std::basic_string< Elem, Traits, Allocator > & data,
+ std::size_t max_size_in_bytes);
-[section:overload23 buffer_copy (23 of 30 overloads)]
+[heading Return Value]
+
+A [link boost_asio.reference.const_buffers_1 `const_buffers_1`] value equivalent to:
-Copies a limited number of bytes from a source buffer to a target buffer.
+ const_buffers_1(
+ data.data(),
+ min(data.size() * sizeof(Elem), max_size_in_bytes));
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
-[heading Parameters]
-
+[heading Remarks]
+
+The buffer is invalidated by any non-const operation called on the given string object.
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes copied.
+[endsect]
+[section:buffer_cast buffer_cast]
+
+[indexterm1 buffer_cast]
+The `boost::asio::buffer_cast` function is used to obtain a pointer to the underlying memory region associated with a buffer.
-[heading Remarks]
-The number of bytes copied is the lesser of:
+ template<
+ typename PointerToPodType>
+ PointerToPodType ``[link boost_asio.reference.buffer_cast.overload1 buffer_cast]``(
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.buffer_cast.overload1 more...]]``
+ template<
+ typename PointerToPodType>
+ PointerToPodType ``[link boost_asio.reference.buffer_cast.overload2 buffer_cast]``(
+ const const_buffer & b);
+ `` [''''»''' [link boost_asio.reference.buffer_cast.overload2 more...]]``
-* `buffer_size(target)`
+[heading Examples:]
+
-* `buffer_size(source)`
+To access the memory of a non-modifiable buffer, use:
-* `max_bytes_to_copy`
+ boost::asio::const_buffer b1 = ...;
+ const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
-[endsect]
+To access the memory of a modifiable buffer, use:
+ boost::asio::mutable_buffer b2 = ...;
+ unsigned char* p2 = boost::asio::buffer_cast<unsigned char*>(b2);
-[section:overload24 buffer_copy (24 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer.
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+[heading Requirements]
- std::size_t buffer_copy(
- const mutable_buffers_1 & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
+[*Header: ][^boost/asio/buffer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
+[section:overload1 buffer_cast (1 of 2 overloads)]
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+Cast a non-modifiable buffer to a specified pointer to POD type.
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-]
+ template<
+ typename PointerToPodType>
+ PointerToPodType buffer_cast(
+ const mutable_buffer & b);
-[heading Return Value]
-
-The number of bytes copied.
+[endsect]
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
-* `buffer_size(target)`
+[section:overload2 buffer_cast (2 of 2 overloads)]
-* `buffer_size(source)`
+Cast a non-modifiable buffer to a specified pointer to POD type.
-* `max_bytes_to_copy`
+ template<
+ typename PointerToPodType>
+ PointerToPodType buffer_cast(
+ const const_buffer & b);
+
+[endsect]
[endsect]
+[section:buffer_copy buffer_copy]
+[indexterm1 buffer_copy]
+The `boost::asio::buffer_copy` function is used to copy bytes from a source buffer (or buffer sequence) to a target buffer (or buffer sequence).
-[section:overload25 buffer_copy (25 of 30 overloads)]
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload1 buffer_copy]``(
+ const mutable_buffer & target,
+ const const_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload2 buffer_copy]``(
+ const mutable_buffer & target,
+ const const_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload2 more...]]``
-Copies a limited number of bytes from a source buffer sequence to a target buffer.
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload3 buffer_copy]``(
+ const mutable_buffer & target,
+ const mutable_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload3 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload4 buffer_copy]``(
+ const mutable_buffer & target,
+ const mutable_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload4 more...]]``
template<
typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t buffer_copy(
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload5 buffer_copy]``(
+ const mutable_buffer & target,
+ const ConstBufferSequence & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload5 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload6 buffer_copy]``(
const mutable_buffers_1 & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
+ const const_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload6 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload7 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const const_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload7 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload8 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const mutable_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload8 more...]]``
-[heading Parameters]
-
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload9 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const mutable_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload9 more...]]``
-[variablelist
-
-[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload10 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const ConstBufferSequence & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload10 more...]]``
-[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload11 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const const_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload11 more...]]``
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload12 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const const_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload12 more...]]``
-]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload13 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const mutable_buffer & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload13 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload14 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const mutable_buffers_1 & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload14 more...]]``
-[heading Return Value]
-
-The number of bytes copied.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload15 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const ConstBufferSequence & source);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload15 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload16 buffer_copy]``(
+ const mutable_buffer & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload16 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload17 buffer_copy]``(
+ const mutable_buffer & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload17 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload18 buffer_copy]``(
+ const mutable_buffer & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload18 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload19 buffer_copy]``(
+ const mutable_buffer & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload19 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload20 buffer_copy]``(
+ const mutable_buffer & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload20 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload21 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload21 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload22 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload22 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload23 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload23 more...]]``
+
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload24 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload24 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload25 buffer_copy]``(
+ const mutable_buffers_1 & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload25 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload26 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload26 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload27 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload27 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload28 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload28 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload29 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload29 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffer_copy.overload30 buffer_copy]``(
+ const MutableBufferSequence & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
+ `` [''''»''' [link boost_asio.reference.buffer_copy.overload30 more...]]``
+
+The `buffer_copy` function is available in two forms:
+
+
+* A 2-argument form: `buffer_copy(target, source)`
-[heading Remarks]
-
-The number of bytes copied is the lesser of:
+
+* A 3-argument form: `buffer_copy(target, source, max_bytes_to_copy)`
+
+Both forms return the number of bytes actually copied. The number of bytes copied is the lesser of:
* `buffer_size(target)`
@@ -45748,27 +45813,26 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
-
+* `If` specified, `max_bytes_to_copy`.
+This prevents buffer overflow, regardless of the buffer sizes used in the copy operation.
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/buffer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload26 buffer_copy (26 of 30 overloads)]
+[section:overload1 buffer_copy (1 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer sequence.
+Copies bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const const_buffer & source,
- std::size_t max_bytes_to_copy);
+ const mutable_buffer & target,
+ const const_buffer & source);
@@ -45777,12 +45841,10 @@
[variablelist
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-
]
@@ -45802,27 +45864,21 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
-
-
[endsect]
-[section:overload27 buffer_copy (27 of 30 overloads)]
+[section:overload2 buffer_copy (2 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer sequence.
+Copies bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const const_buffers_1 & source,
- std::size_t max_bytes_to_copy);
+ const mutable_buffer & target,
+ const const_buffers_1 & source);
@@ -45831,12 +45887,10 @@
[variablelist
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-
]
@@ -45856,27 +45910,21 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
-
-
[endsect]
-[section:overload28 buffer_copy (28 of 30 overloads)]
+[section:overload3 buffer_copy (3 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer sequence.
+Copies bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const mutable_buffer & source,
- std::size_t max_bytes_to_copy);
+ const mutable_buffer & target,
+ const mutable_buffer & source);
@@ -45885,12 +45933,10 @@
[variablelist
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-
]
@@ -45910,27 +45956,21 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
-
-
[endsect]
-[section:overload29 buffer_copy (29 of 30 overloads)]
+[section:overload4 buffer_copy (4 of 30 overloads)]
-Copies a limited number of bytes from a source buffer to a target buffer sequence.
+Copies bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const mutable_buffers_1 & source,
- std::size_t max_bytes_to_copy);
+ const mutable_buffer & target,
+ const mutable_buffers_1 & source);
@@ -45939,12 +45979,10 @@
[variablelist
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-
]
@@ -45964,28 +46002,23 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
-
-
[endsect]
-[section:overload30 buffer_copy (30 of 30 overloads)]
+[section:overload5 buffer_copy (5 of 30 overloads)]
-Copies a limited number of bytes from a source buffer sequence to a target buffer sequence.
+Copies bytes from a source buffer sequence to a target buffer.
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
std::size_t buffer_copy(
- const MutableBufferSequence & target,
- const ConstBufferSequence & source,
- std::size_t max_bytes_to_copy);
+ const mutable_buffer & target,
+ const ConstBufferSequence & source);
@@ -45994,12 +46027,10 @@
[variablelist
-[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
-[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-
]
@@ -46019,59 +46050,51 @@
* `buffer_size(source)`
-* `max_bytes_to_copy`
+[endsect]
-[endsect]
+[section:overload6 buffer_copy (6 of 30 overloads)]
-[endsect]
-[section:buffer_size buffer_size]
+Copies bytes from a source buffer to a target buffer.
-[indexterm1 buffer_size]
-The `boost::asio::buffer_size` function determines the total number of bytes in a buffer or buffer sequence.
-
- std::size_t ``[link boost_asio.reference.buffer_size.overload1 buffer_size]``(
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer_size.overload1 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const const_buffer & source);
- std::size_t ``[link boost_asio.reference.buffer_size.overload2 buffer_size]``(
- const mutable_buffers_1 & b);
- `` [''''»''' [link boost_asio.reference.buffer_size.overload2 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_size.overload3 buffer_size]``(
- const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.buffer_size.overload3 more...]]``
- std::size_t ``[link boost_asio.reference.buffer_size.overload4 buffer_size]``(
- const const_buffers_1 & b);
- `` [''''»''' [link boost_asio.reference.buffer_size.overload4 more...]]``
+[heading Parameters]
+
- template<
- typename BufferSequence>
- std::size_t ``[link boost_asio.reference.buffer_size.overload5 buffer_size]``(
- const BufferSequence & b);
- `` [''''»''' [link boost_asio.reference.buffer_size.overload5 more...]]``
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
-[heading Requirements]
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[*Header: ][^boost/asio/buffer.hpp]
+]
-[*Convenience header: ][^boost/asio.hpp]
+
+[heading Return Value]
+
+The number of bytes copied.
-[section:overload1 buffer_size (1 of 5 overloads)]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-Get the number of bytes in a modifiable buffer.
+* `buffer_size(target)`
- std::size_t buffer_size(
- const mutable_buffer & b);
+* `buffer_size(source)`
+
@@ -46079,963 +46102,792 @@
-[section:overload2 buffer_size (2 of 5 overloads)]
+[section:overload7 buffer_copy (7 of 30 overloads)]
-Get the number of bytes in a modifiable buffer.
+Copies bytes from a source buffer to a target buffer.
- std::size_t buffer_size(
- const mutable_buffers_1 & b);
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const const_buffers_1 & source);
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[section:overload3 buffer_size (3 of 5 overloads)]
+]
-Get the number of bytes in a non-modifiable buffer.
+[heading Return Value]
+
+The number of bytes copied.
- std::size_t buffer_size(
- const const_buffer & b);
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
+* `buffer_size(target)`
-[endsect]
+* `buffer_size(source)`
-[section:overload4 buffer_size (4 of 5 overloads)]
-Get the number of bytes in a non-modifiable buffer.
+[endsect]
- std::size_t buffer_size(
- const const_buffers_1 & b);
+[section:overload8 buffer_copy (8 of 30 overloads)]
-[endsect]
+Copies bytes from a source buffer to a target buffer.
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const mutable_buffer & source);
-[section:overload5 buffer_size (5 of 5 overloads)]
-Get the total number of bytes in a buffer sequence.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
- template<
- typename BufferSequence>
- std::size_t buffer_size(
- const BufferSequence & b);
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+]
-The `BufferSequence` template parameter may meet either of the `ConstBufferSequence` or `MutableBufferSequence` type requirements.
+[heading Return Value]
+
+The number of bytes copied.
-[endsect]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[endsect]
-[section:buffered_read_stream buffered_read_stream]
+* `buffer_size(target)`
-Adds buffering to the read-related operations of a stream.
+* `buffer_size(source)`
- template<
- typename Stream>
- class buffered_read_stream :
- noncopyable
-[heading Types]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.buffered_read_stream.lowest_layer_type [*lowest_layer_type]]]
- [The type of the lowest layer. ]
-
- ]
- [
+[section:overload9 buffer_copy (9 of 30 overloads)]
- [[link boost_asio.reference.buffered_read_stream.next_layer_type [*next_layer_type]]]
- [The type of the next layer. ]
-
- ]
-]
+Copies bytes from a source buffer to a target buffer.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.buffered_read_stream.async_fill [*async_fill]]]
- [Start an asynchronous fill. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.async_read_some [*async_read_some]]]
- [Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.async_write_some [*async_write_some]]]
- [Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.buffered_read_stream [*buffered_read_stream]]]
- [Construct, passing the specified argument to initialise the next layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.close [*close]]]
- [Close the stream. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.fill [*fill]]]
- [Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const mutable_buffers_1 & source);
- Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.in_avail [*in_avail]]]
- [Determine the amount of data that may be read without blocking. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.next_layer [*next_layer]]]
- [Get a reference to the next layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.peek [*peek]]]
- [Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
- Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_read_stream.read_some [*read_some]]]
- [Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+[heading Parameters]
+
- Read some data from the stream. Returns the number of bytes read or 0 if an error occurred. ]
- ]
+[variablelist
- [
- [[link boost_asio.reference.buffered_read_stream.write_some [*write_some]]]
- [Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
- Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred. ]
- ]
-
]
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.buffered_read_stream.default_buffer_size [*default_buffer_size]]]
- [The default buffer size. ]
- ]
+[heading Return Value]
+
+The number of bytes copied.
-]
-The [link boost_asio.reference.buffered_read_stream `buffered_read_stream`] class template can be used to add buffering to the synchronous and asynchronous read operations of a stream.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+* `buffer_size(target)`
-[*Shared] [*objects:] Unsafe.
+* `buffer_size(source)`
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffered_read_stream.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:async_fill buffered_read_stream::async_fill]
-[indexterm2 async_fill..buffered_read_stream]
-Start an asynchronous fill.
+[section:overload10 buffer_copy (10 of 30 overloads)]
- template<
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_fill(
- ReadHandler handler);
+Copies bytes from a source buffer sequence to a target buffer.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const ConstBufferSequence & source);
-[section:async_read_some buffered_read_stream::async_read_some]
+[heading Parameters]
+
-[indexterm2 async_read_some..buffered_read_stream]
-Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- const MutableBufferSequence & buffers,
- ReadHandler handler);
+]
+[heading Return Value]
+
+The number of bytes copied.
-[endsect]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:async_write_some buffered_read_stream::async_write_some]
+* `buffer_size(target)`
-[indexterm2 async_write_some..buffered_read_stream]
-Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
+* `buffer_size(source)`
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- const ConstBufferSequence & buffers,
- WriteHandler handler);
[endsect]
-[section:buffered_read_stream buffered_read_stream::buffered_read_stream]
-[indexterm2 buffered_read_stream..buffered_read_stream]
-Construct, passing the specified argument to initialise the next layer.
+[section:overload11 buffer_copy (11 of 30 overloads)]
- template<
- typename Arg>
- explicit ``[link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload1 buffered_read_stream]``(
- Arg & a);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload1 more...]]``
+Copies bytes from a source buffer to a target buffer sequence.
- template<
- typename Arg>
- ``[link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload2 buffered_read_stream]``(
- Arg & a,
- std::size_t buffer_size);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const const_buffer & source);
-[section:overload1 buffered_read_stream::buffered_read_stream (1 of 2 overloads)]
-Construct, passing the specified argument to initialise the next layer.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
- template<
- typename Arg>
- buffered_read_stream(
- Arg & a);
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::buffered_read_stream (2 of 2 overloads)]
+* `buffer_size(target)`
-Construct, passing the specified argument to initialise the next layer.
+* `buffer_size(source)`
- template<
- typename Arg>
- buffered_read_stream(
- Arg & a,
- std::size_t buffer_size);
[endsect]
-[endsect]
-
-[section:close buffered_read_stream::close]
-[indexterm2 close..buffered_read_stream]
-Close the stream.
+[section:overload12 buffer_copy (12 of 30 overloads)]
- void ``[link boost_asio.reference.buffered_read_stream.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.close.overload1 more...]]``
+Copies bytes from a source buffer to a target buffer sequence.
- boost::system::error_code ``[link boost_asio.reference.buffered_read_stream.close.overload2 close]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.close.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const const_buffers_1 & source);
-[section:overload1 buffered_read_stream::close (1 of 2 overloads)]
-Close the stream.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
- void close();
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::close (2 of 2 overloads)]
+* `buffer_size(target)`
-Close the stream.
+* `buffer_size(source)`
- boost::system::error_code close(
- boost::system::error_code & ec);
[endsect]
-[endsect]
+[section:overload13 buffer_copy (13 of 30 overloads)]
-[section:default_buffer_size buffered_read_stream::default_buffer_size]
-[indexterm2 default_buffer_size..buffered_read_stream]
-The default buffer size.
+Copies bytes from a source buffer to a target buffer sequence.
- static const std::size_t default_buffer_size = implementation_defined;
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const mutable_buffer & source);
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
-[section:fill buffered_read_stream::fill]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[indexterm2 fill..buffered_read_stream]
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
+]
- std::size_t ``[link boost_asio.reference.buffered_read_stream.fill.overload1 fill]``();
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.fill.overload1 more...]]``
+[heading Return Value]
+
+The number of bytes copied.
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
- std::size_t ``[link boost_asio.reference.buffered_read_stream.fill.overload2 fill]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.fill.overload2 more...]]``
+* `buffer_size(target)`
-[section:overload1 buffered_read_stream::fill (1 of 2 overloads)]
+* `buffer_size(source)`
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- std::size_t fill();
+[endsect]
-[endsect]
+[section:overload14 buffer_copy (14 of 30 overloads)]
+Copies bytes from a source buffer to a target buffer sequence.
-[section:overload2 buffered_read_stream::fill (2 of 2 overloads)]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const mutable_buffers_1 & source);
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
- std::size_t fill(
- boost::system::error_code & ec);
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-[endsect]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
-[section:get_io_service buffered_read_stream::get_io_service]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[indexterm2 get_io_service..buffered_read_stream]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+* `buffer_size(target)`
- boost::asio::io_service & get_io_service();
+* `buffer_size(source)`
-[endsect]
-[section:in_avail buffered_read_stream::in_avail]
+[endsect]
-[indexterm2 in_avail..buffered_read_stream]
-Determine the amount of data that may be read without blocking.
- std::size_t ``[link boost_asio.reference.buffered_read_stream.in_avail.overload1 in_avail]``();
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.in_avail.overload1 more...]]``
+[section:overload15 buffer_copy (15 of 30 overloads)]
- std::size_t ``[link boost_asio.reference.buffered_read_stream.in_avail.overload2 in_avail]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.in_avail.overload2 more...]]``
+Copies bytes from a source buffer sequence to a target buffer sequence.
-[section:overload1 buffered_read_stream::in_avail (1 of 2 overloads)]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const ConstBufferSequence & source);
-Determine the amount of data that may be read without blocking.
- std::size_t in_avail();
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
-[endsect]
+]
+[heading Return Value]
+
+The number of bytes copied.
-[section:overload2 buffered_read_stream::in_avail (2 of 2 overloads)]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-Determine the amount of data that may be read without blocking.
+* `buffer_size(target)`
- std::size_t in_avail(
- boost::system::error_code & ec);
+* `buffer_size(source)`
-[endsect]
[endsect]
-[section:lowest_layer buffered_read_stream::lowest_layer]
-
-[indexterm2 lowest_layer..buffered_read_stream]
-Get a reference to the lowest layer.
- lowest_layer_type & ``[link boost_asio.reference.buffered_read_stream.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.lowest_layer.overload1 more...]]``
+[section:overload16 buffer_copy (16 of 30 overloads)]
-Get a const reference to the lowest layer.
+Copies a limited number of bytes from a source buffer to a target buffer.
- const lowest_layer_type & ``[link boost_asio.reference.buffered_read_stream.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.lowest_layer.overload2 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffer & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_read_stream::lowest_layer (1 of 2 overloads)]
+[heading Parameters]
+
-Get a reference to the lowest layer.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
- lowest_layer_type & lowest_layer();
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::lowest_layer (2 of 2 overloads)]
+* `buffer_size(target)`
-Get a const reference to the lowest layer.
+* `buffer_size(source)`
- const lowest_layer_type & lowest_layer() const;
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:lowest_layer_type buffered_read_stream::lowest_layer_type]
-
-[indexterm2 lowest_layer_type..buffered_read_stream]
-The type of the lowest layer.
-
-
- typedef next_layer_type::lowest_layer_type lowest_layer_type;
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffered_read_stream.hpp]
+[section:overload17 buffer_copy (17 of 30 overloads)]
-[*Convenience header: ][^boost/asio.hpp]
+Copies a limited number of bytes from a source buffer to a target buffer.
-[endsect]
+ std::size_t buffer_copy(
+ const mutable_buffer & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[section:next_layer buffered_read_stream::next_layer]
-[indexterm2 next_layer..buffered_read_stream]
-Get a reference to the next layer.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
- next_layer_type & next_layer();
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
-[section:next_layer_type buffered_read_stream::next_layer_type]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[indexterm2 next_layer_type..buffered_read_stream]
-The type of the next layer.
+* `buffer_size(target)`
- typedef boost::remove_reference< Stream >::type next_layer_type;
+* `buffer_size(source)`
-[heading Requirements]
+* `max_bytes_to_copy`
-[*Header: ][^boost/asio/buffered_read_stream.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:peek buffered_read_stream::peek]
-
-[indexterm2 peek..buffered_read_stream]
-Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
-
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.peek.overload1 peek]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.peek.overload1 more...]]``
+[section:overload18 buffer_copy (18 of 30 overloads)]
-Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
+Copies a limited number of bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.peek.overload2 peek]``(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.peek.overload2 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffer & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_read_stream::peek (1 of 2 overloads)]
+[heading Parameters]
+
-Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t peek(
- const MutableBufferSequence & buffers);
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::peek (2 of 2 overloads)]
+* `buffer_size(target)`
-Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
+* `buffer_size(source)`
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t peek(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:read_some buffered_read_stream::read_some]
-
-[indexterm2 read_some..buffered_read_stream]
-Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.read_some.overload1 read_some]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.read_some.overload1 more...]]``
+[section:overload19 buffer_copy (19 of 30 overloads)]
-Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
+Copies a limited number of bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.read_some.overload2 read_some]``(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.read_some.overload2 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffer & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_read_stream::read_some (1 of 2 overloads)]
+[heading Parameters]
+
-Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers);
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::read_some (2 of 2 overloads)]
+* `buffer_size(target)`
-Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
+* `buffer_size(source)`
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:write_some buffered_read_stream::write_some]
-
-[indexterm2 write_some..buffered_read_stream]
-Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.write_some.overload1 write_some]``(
- const ConstBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.write_some.overload1 more...]]``
+[section:overload20 buffer_copy (20 of 30 overloads)]
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
+Copies a limited number of bytes from a source buffer sequence to a target buffer.
template<
typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_read_stream.write_some.overload2 write_some]``(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_read_stream.write_some.overload2 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffer & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_read_stream::write_some (1 of 2 overloads)]
+[heading Parameters]
+
-Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers);
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_read_stream::write_some (2 of 2 overloads)]
+* `buffer_size(target)`
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
+* `buffer_size(source)`
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[endsect]
-[section:buffered_stream buffered_stream]
+[section:overload21 buffer_copy (21 of 30 overloads)]
-Adds buffering to the read- and write-related operations of a stream.
+Copies a limited number of bytes from a source buffer to a target buffer.
- template<
- typename Stream>
- class buffered_stream :
- noncopyable
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.buffered_stream.lowest_layer_type [*lowest_layer_type]]]
- [The type of the lowest layer. ]
+[variablelist
- ]
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
- [
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
- [[link boost_asio.reference.buffered_stream.next_layer_type [*next_layer_type]]]
- [The type of the next layer. ]
-
- ]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.buffered_stream.async_fill [*async_fill]]]
- [Start an asynchronous fill. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.async_flush [*async_flush]]]
- [Start an asynchronous flush. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.async_read_some [*async_read_some]]]
- [Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.async_write_some [*async_write_some]]]
- [Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.buffered_stream [*buffered_stream]]]
- [Construct, passing the specified argument to initialise the next layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.close [*close]]]
- [Close the stream. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.fill [*fill]]]
- [Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
-
- Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.flush [*flush]]]
- [Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
- Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.in_avail [*in_avail]]]
- [Determine the amount of data that may be read without blocking. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
+[heading Return Value]
+
+The number of bytes copied.
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.next_layer [*next_layer]]]
- [Get a reference to the next layer. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.peek [*peek]]]
- [Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
- Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.read_some [*read_some]]]
- [Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
- Read some data from the stream. Returns the number of bytes read or 0 if an error occurred. ]
- ]
-
- [
- [[link boost_asio.reference.buffered_stream.write_some [*write_some]]]
- [Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
- Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred. ]
- ]
-
-]
+* `buffer_size(target)`
-The [link boost_asio.reference.buffered_stream `buffered_stream`] class template can be used to add buffering to the synchronous and asynchronous read and write operations of a stream.
+* `buffer_size(source)`
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+* `max_bytes_to_copy`
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/buffered_stream.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload22 buffer_copy (22 of 30 overloads)]
-[section:async_fill buffered_stream::async_fill]
-[indexterm2 async_fill..buffered_stream]
-Start an asynchronous fill.
+Copies a limited number of bytes from a source buffer to a target buffer.
- template<
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_fill(
- ReadHandler handler);
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
-[section:async_flush buffered_stream::async_flush]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-[indexterm2 async_flush..buffered_stream]
-Start an asynchronous flush.
+]
- template<
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_flush(
- WriteHandler handler);
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[endsect]
+* `buffer_size(target)`
-[section:async_read_some buffered_stream::async_read_some]
+* `buffer_size(source)`
-[indexterm2 async_read_some..buffered_stream]
-Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
+* `max_bytes_to_copy`
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- const MutableBufferSequence & buffers,
- ReadHandler handler);
@@ -47043,355 +46895,373 @@
-[section:async_write_some buffered_stream::async_write_some]
-
-[indexterm2 async_write_some..buffered_stream]
-Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
-
-
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- const ConstBufferSequence & buffers,
- WriteHandler handler);
-
-
-
-[endsect]
+[section:overload23 buffer_copy (23 of 30 overloads)]
-[section:buffered_stream buffered_stream::buffered_stream]
+Copies a limited number of bytes from a source buffer to a target buffer.
-[indexterm2 buffered_stream..buffered_stream]
-Construct, passing the specified argument to initialise the next layer.
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
- template<
- typename Arg>
- explicit ``[link boost_asio.reference.buffered_stream.buffered_stream.overload1 buffered_stream]``(
- Arg & a);
- `` [''''»''' [link boost_asio.reference.buffered_stream.buffered_stream.overload1 more...]]``
- template<
- typename Arg>
- explicit ``[link boost_asio.reference.buffered_stream.buffered_stream.overload2 buffered_stream]``(
- Arg & a,
- std::size_t read_buffer_size,
- std::size_t write_buffer_size);
- `` [''''»''' [link boost_asio.reference.buffered_stream.buffered_stream.overload2 more...]]``
+[heading Parameters]
+
-[section:overload1 buffered_stream::buffered_stream (1 of 2 overloads)]
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
-Construct, passing the specified argument to initialise the next layer.
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
- template<
- typename Arg>
- buffered_stream(
- Arg & a);
+[heading Return Value]
+
+The number of bytes copied.
-[endsect]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
+* `buffer_size(target)`
-[section:overload2 buffered_stream::buffered_stream (2 of 2 overloads)]
+* `buffer_size(source)`
-Construct, passing the specified argument to initialise the next layer.
+* `max_bytes_to_copy`
- template<
- typename Arg>
- buffered_stream(
- Arg & a,
- std::size_t read_buffer_size,
- std::size_t write_buffer_size);
[endsect]
-[endsect]
-[section:close buffered_stream::close]
+[section:overload24 buffer_copy (24 of 30 overloads)]
-[indexterm2 close..buffered_stream]
-Close the stream.
+Copies a limited number of bytes from a source buffer to a target buffer.
- void ``[link boost_asio.reference.buffered_stream.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.buffered_stream.close.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.buffered_stream.close.overload2 close]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.close.overload2 more...]]``
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_stream::close (1 of 2 overloads)]
+[heading Parameters]
+
-Close the stream.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
- void close();
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_stream::close (2 of 2 overloads)]
+* `buffer_size(target)`
-Close the stream.
+* `buffer_size(source)`
- boost::system::error_code close(
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:fill buffered_stream::fill]
-
-[indexterm2 fill..buffered_stream]
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- std::size_t ``[link boost_asio.reference.buffered_stream.fill.overload1 fill]``();
- `` [''''»''' [link boost_asio.reference.buffered_stream.fill.overload1 more...]]``
+[section:overload25 buffer_copy (25 of 30 overloads)]
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
+Copies a limited number of bytes from a source buffer sequence to a target buffer.
- std::size_t ``[link boost_asio.reference.buffered_stream.fill.overload2 fill]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.fill.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t buffer_copy(
+ const mutable_buffers_1 & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_stream::fill (1 of 2 overloads)]
+[heading Parameters]
+
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
+[variablelist
+
+[[target][A modifiable buffer representing the memory region to which the bytes will be copied.]]
+[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
- std::size_t fill();
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_stream::fill (2 of 2 overloads)]
+* `buffer_size(target)`
-Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
+* `buffer_size(source)`
- std::size_t fill(
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:flush buffered_stream::flush]
-
-[indexterm2 flush..buffered_stream]
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
- std::size_t ``[link boost_asio.reference.buffered_stream.flush.overload1 flush]``();
- `` [''''»''' [link boost_asio.reference.buffered_stream.flush.overload1 more...]]``
+[section:overload26 buffer_copy (26 of 30 overloads)]
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+Copies a limited number of bytes from a source buffer to a target buffer sequence.
- std::size_t ``[link boost_asio.reference.buffered_stream.flush.overload2 flush]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.flush.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const const_buffer & source,
+ std::size_t max_bytes_to_copy);
-[section:overload1 buffered_stream::flush (1 of 2 overloads)]
+[heading Parameters]
+
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
- std::size_t flush();
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes copied.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[section:overload2 buffered_stream::flush (2 of 2 overloads)]
+* `buffer_size(target)`
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+* `buffer_size(source)`
- std::size_t flush(
- boost::system::error_code & ec);
+* `max_bytes_to_copy`
-[endsect]
[endsect]
-[section:get_io_service buffered_stream::get_io_service]
-
-[indexterm2 get_io_service..buffered_stream]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+[section:overload27 buffer_copy (27 of 30 overloads)]
- boost::asio::io_service & get_io_service();
+Copies a limited number of bytes from a source buffer to a target buffer sequence.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const const_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[section:in_avail buffered_stream::in_avail]
-[indexterm2 in_avail..buffered_stream]
-Determine the amount of data that may be read without blocking.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
- std::size_t ``[link boost_asio.reference.buffered_stream.in_avail.overload1 in_avail]``();
- `` [''''»''' [link boost_asio.reference.buffered_stream.in_avail.overload1 more...]]``
+[[source][A non-modifiable buffer representing the memory region from which the bytes will be copied.]]
- std::size_t ``[link boost_asio.reference.buffered_stream.in_avail.overload2 in_avail]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.in_avail.overload2 more...]]``
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[section:overload1 buffered_stream::in_avail (1 of 2 overloads)]
+[heading Return Value]
+
+The number of bytes copied.
-Determine the amount of data that may be read without blocking.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
- std::size_t in_avail();
+* `buffer_size(target)`
-[endsect]
+* `buffer_size(source)`
+* `max_bytes_to_copy`
-[section:overload2 buffered_stream::in_avail (2 of 2 overloads)]
-Determine the amount of data that may be read without blocking.
+[endsect]
- std::size_t in_avail(
- boost::system::error_code & ec);
+[section:overload28 buffer_copy (28 of 30 overloads)]
-[endsect]
+Copies a limited number of bytes from a source buffer to a target buffer sequence.
-[endsect]
-[section:lowest_layer buffered_stream::lowest_layer]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const mutable_buffer & source,
+ std::size_t max_bytes_to_copy);
-[indexterm2 lowest_layer..buffered_stream]
-Get a reference to the lowest layer.
- lowest_layer_type & ``[link boost_asio.reference.buffered_stream.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.buffered_stream.lowest_layer.overload1 more...]]``
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
-Get a const reference to the lowest layer.
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
- const lowest_layer_type & ``[link boost_asio.reference.buffered_stream.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.buffered_stream.lowest_layer.overload2 more...]]``
+]
-[section:overload1 buffered_stream::lowest_layer (1 of 2 overloads)]
+[heading Return Value]
+
+The number of bytes copied.
-Get a reference to the lowest layer.
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
- lowest_layer_type & lowest_layer();
+* `buffer_size(target)`
+* `buffer_size(source)`
-[endsect]
+* `max_bytes_to_copy`
-[section:overload2 buffered_stream::lowest_layer (2 of 2 overloads)]
-Get a const reference to the lowest layer.
+[endsect]
- const lowest_layer_type & lowest_layer() const;
+[section:overload29 buffer_copy (29 of 30 overloads)]
-[endsect]
+Copies a limited number of bytes from a source buffer to a target buffer sequence.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const mutable_buffers_1 & source,
+ std::size_t max_bytes_to_copy);
-[section:lowest_layer_type buffered_stream::lowest_layer_type]
-[indexterm2 lowest_layer_type..buffered_stream]
-The type of the lowest layer.
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
- typedef next_layer_type::lowest_layer_type lowest_layer_type;
+[[source][A modifiable buffer representing the memory region from which the bytes will be copied. The contents of the source buffer will not be modified.]]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
+]
-[heading Requirements]
-[*Header: ][^boost/asio/buffered_stream.hpp]
+[heading Return Value]
+
+The number of bytes copied.
-[*Convenience header: ][^boost/asio.hpp]
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-[endsect]
+* `buffer_size(target)`
-[section:next_layer buffered_stream::next_layer]
+* `buffer_size(source)`
-[indexterm2 next_layer..buffered_stream]
-Get a reference to the next layer.
+* `max_bytes_to_copy`
- next_layer_type & next_layer();
@@ -47399,120 +47269,120 @@
-[section:next_layer_type buffered_stream::next_layer_type]
-
-[indexterm2 next_layer_type..buffered_stream]
-The type of the next layer.
+[section:overload30 buffer_copy (30 of 30 overloads)]
- typedef boost::remove_reference< Stream >::type next_layer_type;
+Copies a limited number of bytes from a source buffer sequence to a target buffer sequence.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t buffer_copy(
+ const MutableBufferSequence & target,
+ const ConstBufferSequence & source,
+ std::size_t max_bytes_to_copy);
-[heading Requirements]
-[*Header: ][^boost/asio/buffered_stream.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Parameters]
+
+[variablelist
+
+[[target][A modifiable buffer sequence representing the memory regions to which the bytes will be copied.]]
-[endsect]
+[[source][A non-modifiable buffer sequence representing the memory regions from which the bytes will be copied.]]
+[[max_bytes_to_copy][The maximum number of bytes to be copied.]]
-[section:peek buffered_stream::peek]
+]
-[indexterm2 peek..buffered_stream]
-Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
+[heading Return Value]
+
+The number of bytes copied.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.peek.overload1 peek]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_stream.peek.overload1 more...]]``
+[heading Remarks]
+
+The number of bytes copied is the lesser of:
-Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
+* `buffer_size(target)`
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.peek.overload2 peek]``(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.peek.overload2 more...]]``
+* `buffer_size(source)`
-[section:overload1 buffered_stream::peek (1 of 2 overloads)]
+* `max_bytes_to_copy`
-Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t peek(
- const MutableBufferSequence & buffers);
+[endsect]
[endsect]
+[section:buffer_size buffer_size]
+[indexterm1 buffer_size]
+The `boost::asio::buffer_size` function determines the total number of bytes in a buffer or buffer sequence.
-[section:overload2 buffered_stream::peek (2 of 2 overloads)]
+
+ std::size_t ``[link boost_asio.reference.buffer_size.overload1 buffer_size]``(
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.buffer_size.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_size.overload2 buffer_size]``(
+ const mutable_buffers_1 & b);
+ `` [''''»''' [link boost_asio.reference.buffer_size.overload2 more...]]``
-Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
+ std::size_t ``[link boost_asio.reference.buffer_size.overload3 buffer_size]``(
+ const const_buffer & b);
+ `` [''''»''' [link boost_asio.reference.buffer_size.overload3 more...]]``
+ std::size_t ``[link boost_asio.reference.buffer_size.overload4 buffer_size]``(
+ const const_buffers_1 & b);
+ `` [''''»''' [link boost_asio.reference.buffer_size.overload4 more...]]``
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t peek(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+ typename BufferSequence>
+ std::size_t ``[link boost_asio.reference.buffer_size.overload5 buffer_size]``(
+ const BufferSequence & b);
+ `` [''''»''' [link boost_asio.reference.buffer_size.overload5 more...]]``
+[heading Requirements]
+[*Header: ][^boost/asio/buffer.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:overload1 buffer_size (1 of 5 overloads)]
-[section:read_some buffered_stream::read_some]
-[indexterm2 read_some..buffered_stream]
-Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+Get the number of bytes in a modifiable buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.read_some.overload1 read_some]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_stream.read_some.overload1 more...]]``
+ std::size_t buffer_size(
+ const mutable_buffer & b);
-Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
+[endsect]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.read_some.overload2 read_some]``(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.read_some.overload2 more...]]``
-[section:overload1 buffered_stream::read_some (1 of 2 overloads)]
+[section:overload2 buffer_size (2 of 5 overloads)]
-Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+Get the number of bytes in a modifiable buffer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers);
+ std::size_t buffer_size(
+ const mutable_buffers_1 & b);
@@ -47520,59 +47390,29 @@
-[section:overload2 buffered_stream::read_some (2 of 2 overloads)]
-
-
-Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
+[section:overload3 buffer_size (3 of 5 overloads)]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+Get the number of bytes in a non-modifiable buffer.
+ std::size_t buffer_size(
+ const const_buffer & b);
-[endsect]
[endsect]
-[section:write_some buffered_stream::write_some]
-
-[indexterm2 write_some..buffered_stream]
-Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
-
-
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.write_some.overload1 write_some]``(
- const ConstBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_stream.write_some.overload1 more...]]``
-
-
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
-
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_stream.write_some.overload2 write_some]``(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_stream.write_some.overload2 more...]]``
-
-[section:overload1 buffered_stream::write_some (1 of 2 overloads)]
+[section:overload4 buffer_size (4 of 5 overloads)]
-Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
+Get the number of bytes in a non-modifiable buffer.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers);
+ std::size_t buffer_size(
+ const const_buffers_1 & b);
@@ -47580,21 +47420,19 @@
-[section:overload2 buffered_stream::write_some (2 of 2 overloads)]
+[section:overload5 buffer_size (5 of 5 overloads)]
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
+Get the total number of bytes in a buffer sequence.
template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
-
+ typename BufferSequence>
+ std::size_t buffer_size(
+ const BufferSequence & b);
-[endsect]
+The `BufferSequence` template parameter may meet either of the `ConstBufferSequence` or `MutableBufferSequence` type requirements.
[endsect]
@@ -47602,15 +47440,15 @@
[endsect]
-[section:buffered_write_stream buffered_write_stream]
+[section:buffered_read_stream buffered_read_stream]
-Adds buffering to the write-related operations of a stream.
+Adds buffering to the read-related operations of a stream.
template<
typename Stream>
- class buffered_write_stream :
+ class buffered_read_stream :
noncopyable
@@ -47620,14 +47458,14 @@
[
- [[link boost_asio.reference.buffered_write_stream.lowest_layer_type [*lowest_layer_type]]]
+ [[link boost_asio.reference.buffered_read_stream.lowest_layer_type [*lowest_layer_type]]]
[The type of the lowest layer. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.next_layer_type [*next_layer_type]]]
+ [[link boost_asio.reference.buffered_read_stream.next_layer_type [*next_layer_type]]]
[The type of the next layer. ]
]
@@ -47639,78 +47477,78 @@
[[Name][Description]]
[
- [[link boost_asio.reference.buffered_write_stream.async_flush [*async_flush]]]
- [Start an asynchronous flush. ]
+ [[link boost_asio.reference.buffered_read_stream.async_fill [*async_fill]]]
+ [Start an asynchronous fill. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.async_read_some [*async_read_some]]]
+ [[link boost_asio.reference.buffered_read_stream.async_read_some [*async_read_some]]]
[Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.async_write_some [*async_write_some]]]
+ [[link boost_asio.reference.buffered_read_stream.async_write_some [*async_write_some]]]
[Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.buffered_write_stream [*buffered_write_stream]]]
+ [[link boost_asio.reference.buffered_read_stream.buffered_read_stream [*buffered_read_stream]]]
[Construct, passing the specified argument to initialise the next layer. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.close [*close]]]
+ [[link boost_asio.reference.buffered_read_stream.close [*close]]]
[Close the stream. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.flush [*flush]]]
- [Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
+ [[link boost_asio.reference.buffered_read_stream.fill [*fill]]]
+ [Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred. ]
+ Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.get_io_service [*get_io_service]]]
+ [[link boost_asio.reference.buffered_read_stream.get_io_service [*get_io_service]]]
[Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.in_avail [*in_avail]]]
+ [[link boost_asio.reference.buffered_read_stream.in_avail [*in_avail]]]
[Determine the amount of data that may be read without blocking. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.lowest_layer [*lowest_layer]]]
+ [[link boost_asio.reference.buffered_read_stream.lowest_layer [*lowest_layer]]]
[Get a reference to the lowest layer.
Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.next_layer [*next_layer]]]
+ [[link boost_asio.reference.buffered_read_stream.next_layer [*next_layer]]]
[Get a reference to the next layer. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.peek [*peek]]]
+ [[link boost_asio.reference.buffered_read_stream.peek [*peek]]]
[Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.read_some [*read_some]]]
+ [[link boost_asio.reference.buffered_read_stream.read_some [*read_some]]]
[Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
Read some data from the stream. Returns the number of bytes read or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffered_write_stream.write_some [*write_some]]]
+ [[link boost_asio.reference.buffered_read_stream.write_some [*write_some]]]
[Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
- Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw. ]
+ Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred. ]
]
]
@@ -47720,13 +47558,13 @@
[[Name][Description]]
[
- [[link boost_asio.reference.buffered_write_stream.default_buffer_size [*default_buffer_size]]]
+ [[link boost_asio.reference.buffered_read_stream.default_buffer_size [*default_buffer_size]]]
[The default buffer size. ]
]
]
-The [link boost_asio.reference.buffered_write_stream `buffered_write_stream`] class template can be used to add buffering to the synchronous and asynchronous write operations of a stream.
+The [link boost_asio.reference.buffered_read_stream `buffered_read_stream`] class template can be used to add buffering to the synchronous and asynchronous read operations of a stream.
[heading Thread Safety]
@@ -47740,21 +47578,21 @@
[heading Requirements]
-[*Header: ][^boost/asio/buffered_write_stream.hpp]
+[*Header: ][^boost/asio/buffered_read_stream.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:async_flush buffered_write_stream::async_flush]
+[section:async_fill buffered_read_stream::async_fill]
-[indexterm2 async_flush..buffered_write_stream]
-Start an asynchronous flush.
+[indexterm2 async_fill..buffered_read_stream]
+Start an asynchronous fill.
template<
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_flush(
- WriteHandler handler);
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_fill(
+ ReadHandler handler);
@@ -47762,9 +47600,9 @@
-[section:async_read_some buffered_write_stream::async_read_some]
+[section:async_read_some buffered_read_stream::async_read_some]
-[indexterm2 async_read_some..buffered_write_stream]
+[indexterm2 async_read_some..buffered_read_stream]
Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
@@ -47781,9 +47619,9 @@
-[section:async_write_some buffered_write_stream::async_write_some]
+[section:async_write_some buffered_read_stream::async_write_some]
-[indexterm2 async_write_some..buffered_write_stream]
+[indexterm2 async_write_some..buffered_read_stream]
Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
@@ -47799,27 +47637,27 @@
[endsect]
-[section:buffered_write_stream buffered_write_stream::buffered_write_stream]
+[section:buffered_read_stream buffered_read_stream::buffered_read_stream]
-[indexterm2 buffered_write_stream..buffered_write_stream]
+[indexterm2 buffered_read_stream..buffered_read_stream]
Construct, passing the specified argument to initialise the next layer.
template<
typename Arg>
- explicit ``[link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload1 buffered_write_stream]``(
+ explicit ``[link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload1 buffered_read_stream]``(
Arg & a);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload1 more...]]``
template<
typename Arg>
- ``[link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload2 buffered_write_stream]``(
+ ``[link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload2 buffered_read_stream]``(
Arg & a,
std::size_t buffer_size);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.buffered_read_stream.overload2 more...]]``
-[section:overload1 buffered_write_stream::buffered_write_stream (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::buffered_read_stream (1 of 2 overloads)]
Construct, passing the specified argument to initialise the next layer.
@@ -47827,7 +47665,7 @@
template<
typename Arg>
- buffered_write_stream(
+ buffered_read_stream(
Arg & a);
@@ -47836,7 +47674,7 @@
-[section:overload2 buffered_write_stream::buffered_write_stream (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::buffered_read_stream (2 of 2 overloads)]
Construct, passing the specified argument to initialise the next layer.
@@ -47844,7 +47682,7 @@
template<
typename Arg>
- buffered_write_stream(
+ buffered_read_stream(
Arg & a,
std::size_t buffer_size);
@@ -47855,21 +47693,21 @@
[endsect]
-[section:close buffered_write_stream::close]
+[section:close buffered_read_stream::close]
-[indexterm2 close..buffered_write_stream]
+[indexterm2 close..buffered_read_stream]
Close the stream.
- void ``[link boost_asio.reference.buffered_write_stream.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.close.overload1 more...]]``
+ void ``[link boost_asio.reference.buffered_read_stream.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.close.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.buffered_write_stream.close.overload2 close]``(
+ boost::system::error_code ``[link boost_asio.reference.buffered_read_stream.close.overload2 close]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.close.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.close.overload2 more...]]``
-[section:overload1 buffered_write_stream::close (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::close (1 of 2 overloads)]
Close the stream.
@@ -47883,7 +47721,7 @@
-[section:overload2 buffered_write_stream::close (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::close (2 of 2 overloads)]
Close the stream.
@@ -47900,9 +47738,9 @@
[endsect]
-[section:default_buffer_size buffered_write_stream::default_buffer_size]
+[section:default_buffer_size buffered_read_stream::default_buffer_size]
-[indexterm2 default_buffer_size..buffered_write_stream]
+[indexterm2 default_buffer_size..buffered_read_stream]
The default buffer size.
@@ -47913,31 +47751,31 @@
[endsect]
-[section:flush buffered_write_stream::flush]
+[section:fill buffered_read_stream::fill]
-[indexterm2 flush..buffered_write_stream]
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
+[indexterm2 fill..buffered_read_stream]
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- std::size_t ``[link boost_asio.reference.buffered_write_stream.flush.overload1 flush]``();
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.flush.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.fill.overload1 fill]``();
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.fill.overload1 more...]]``
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
- std::size_t ``[link boost_asio.reference.buffered_write_stream.flush.overload2 flush]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.fill.overload2 fill]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.flush.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.fill.overload2 more...]]``
-[section:overload1 buffered_write_stream::flush (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::fill (1 of 2 overloads)]
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- std::size_t flush();
+ std::size_t fill();
@@ -47945,13 +47783,13 @@
-[section:overload2 buffered_write_stream::flush (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::fill (2 of 2 overloads)]
-Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
- std::size_t flush(
+ std::size_t fill(
boost::system::error_code & ec);
@@ -47962,9 +47800,9 @@
[endsect]
-[section:get_io_service buffered_write_stream::get_io_service]
+[section:get_io_service buffered_read_stream::get_io_service]
-[indexterm2 get_io_service..buffered_write_stream]
+[indexterm2 get_io_service..buffered_read_stream]
Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
@@ -47975,21 +47813,21 @@
[endsect]
-[section:in_avail buffered_write_stream::in_avail]
+[section:in_avail buffered_read_stream::in_avail]
-[indexterm2 in_avail..buffered_write_stream]
+[indexterm2 in_avail..buffered_read_stream]
Determine the amount of data that may be read without blocking.
- std::size_t ``[link boost_asio.reference.buffered_write_stream.in_avail.overload1 in_avail]``();
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.in_avail.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.in_avail.overload1 in_avail]``();
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.in_avail.overload1 more...]]``
- std::size_t ``[link boost_asio.reference.buffered_write_stream.in_avail.overload2 in_avail]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.in_avail.overload2 in_avail]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.in_avail.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.in_avail.overload2 more...]]``
-[section:overload1 buffered_write_stream::in_avail (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::in_avail (1 of 2 overloads)]
Determine the amount of data that may be read without blocking.
@@ -48003,7 +47841,7 @@
-[section:overload2 buffered_write_stream::in_avail (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::in_avail (2 of 2 overloads)]
Determine the amount of data that may be read without blocking.
@@ -48019,24 +47857,24 @@
[endsect]
-[section:lowest_layer buffered_write_stream::lowest_layer]
+[section:lowest_layer buffered_read_stream::lowest_layer]
-[indexterm2 lowest_layer..buffered_write_stream]
+[indexterm2 lowest_layer..buffered_read_stream]
Get a reference to the lowest layer.
- lowest_layer_type & ``[link boost_asio.reference.buffered_write_stream.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.lowest_layer.overload1 more...]]``
+ lowest_layer_type & ``[link boost_asio.reference.buffered_read_stream.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.lowest_layer.overload1 more...]]``
Get a const reference to the lowest layer.
- const lowest_layer_type & ``[link boost_asio.reference.buffered_write_stream.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.lowest_layer.overload2 more...]]``
+ const lowest_layer_type & ``[link boost_asio.reference.buffered_read_stream.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.lowest_layer.overload2 more...]]``
-[section:overload1 buffered_write_stream::lowest_layer (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::lowest_layer (1 of 2 overloads)]
Get a reference to the lowest layer.
@@ -48050,7 +47888,7 @@
-[section:overload2 buffered_write_stream::lowest_layer (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::lowest_layer (2 of 2 overloads)]
Get a const reference to the lowest layer.
@@ -48066,9 +47904,9 @@
[endsect]
-[section:lowest_layer_type buffered_write_stream::lowest_layer_type]
+[section:lowest_layer_type buffered_read_stream::lowest_layer_type]
-[indexterm2 lowest_layer_type..buffered_write_stream]
+[indexterm2 lowest_layer_type..buffered_read_stream]
The type of the lowest layer.
@@ -48078,7 +47916,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/buffered_write_stream.hpp]
+[*Header: ][^boost/asio/buffered_read_stream.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -48087,9 +47925,9 @@
-[section:next_layer buffered_write_stream::next_layer]
+[section:next_layer buffered_read_stream::next_layer]
-[indexterm2 next_layer..buffered_write_stream]
+[indexterm2 next_layer..buffered_read_stream]
Get a reference to the next layer.
@@ -48101,9 +47939,9 @@
-[section:next_layer_type buffered_write_stream::next_layer_type]
+[section:next_layer_type buffered_read_stream::next_layer_type]
-[indexterm2 next_layer_type..buffered_write_stream]
+[indexterm2 next_layer_type..buffered_read_stream]
The type of the next layer.
@@ -48113,7 +47951,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/buffered_write_stream.hpp]
+[*Header: ][^boost/asio/buffered_read_stream.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -48121,17 +47959,17 @@
[endsect]
-[section:peek buffered_write_stream::peek]
+[section:peek buffered_read_stream::peek]
-[indexterm2 peek..buffered_write_stream]
+[indexterm2 peek..buffered_read_stream]
Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
template<
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.peek.overload1 peek]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.peek.overload1 peek]``(
const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.peek.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.peek.overload1 more...]]``
Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
@@ -48139,13 +47977,13 @@
template<
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.peek.overload2 peek]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.peek.overload2 peek]``(
const MutableBufferSequence & buffers,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.peek.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.peek.overload2 more...]]``
-[section:overload1 buffered_write_stream::peek (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::peek (1 of 2 overloads)]
Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
@@ -48162,7 +48000,7 @@
-[section:overload2 buffered_write_stream::peek (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::peek (2 of 2 overloads)]
Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
@@ -48181,17 +48019,17 @@
[endsect]
-[section:read_some buffered_write_stream::read_some]
+[section:read_some buffered_read_stream::read_some]
-[indexterm2 read_some..buffered_write_stream]
+[indexterm2 read_some..buffered_read_stream]
Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
template<
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.read_some.overload1 read_some]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.read_some.overload1 read_some]``(
const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.read_some.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.read_some.overload1 more...]]``
Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
@@ -48199,13 +48037,13 @@
template<
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.read_some.overload2 read_some]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.read_some.overload2 read_some]``(
const MutableBufferSequence & buffers,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.read_some.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.read_some.overload2 more...]]``
-[section:overload1 buffered_write_stream::read_some (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::read_some (1 of 2 overloads)]
Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
@@ -48222,7 +48060,7 @@
-[section:overload2 buffered_write_stream::read_some (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::read_some (2 of 2 overloads)]
Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
@@ -48241,31 +48079,31 @@
[endsect]
-[section:write_some buffered_write_stream::write_some]
+[section:write_some buffered_read_stream::write_some]
-[indexterm2 write_some..buffered_write_stream]
+[indexterm2 write_some..buffered_read_stream]
Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
template<
typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.write_some.overload1 write_some]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.write_some.overload1 write_some]``(
const ConstBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.write_some.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.write_some.overload1 more...]]``
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw.
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
template<
typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.buffered_write_stream.write_some.overload2 write_some]``(
+ std::size_t ``[link boost_asio.reference.buffered_read_stream.write_some.overload2 write_some]``(
const ConstBufferSequence & buffers,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.buffered_write_stream.write_some.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_read_stream.write_some.overload2 more...]]``
-[section:overload1 buffered_write_stream::write_some (1 of 2 overloads)]
+[section:overload1 buffered_read_stream::write_some (1 of 2 overloads)]
Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
@@ -48282,10 +48120,10 @@
-[section:overload2 buffered_write_stream::write_some (2 of 2 overloads)]
+[section:overload2 buffered_read_stream::write_some (2 of 2 overloads)]
-Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw.
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
template<
@@ -48304,62 +48142,16 @@
[endsect]
-
-[section:buffers_begin buffers_begin]
-
-[indexterm1 buffers_begin]
-Construct an iterator representing the beginning of the buffers' data.
-
-
- template<
- typename BufferSequence>
- buffers_iterator< BufferSequence > buffers_begin(
- const BufferSequence & buffers);
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[section:buffers_end buffers_end]
-
-[indexterm1 buffers_end]
-Construct an iterator representing the end of the buffers' data.
-
-
- template<
- typename BufferSequence>
- buffers_iterator< BufferSequence > buffers_end(
- const BufferSequence & buffers);
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-[section:buffers_iterator buffers_iterator]
+[section:buffered_stream buffered_stream]
-A random access iterator over the bytes in a buffer sequence.
+Adds buffering to the read- and write-related operations of a stream.
template<
- typename BufferSequence,
- typename ByteType = char>
- class buffers_iterator
+ typename Stream>
+ class buffered_stream :
+ noncopyable
[heading Types]
@@ -48368,36 +48160,15 @@
[
- [[link boost_asio.reference.buffers_iterator.difference_type [*difference_type]]]
- [The type used for the distance between two iterators. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.buffers_iterator.iterator_category [*iterator_category]]]
- [The iterator category. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.buffers_iterator.pointer [*pointer]]]
- [The type of the result of applying operator->() to the iterator. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.buffers_iterator.reference [*reference]]]
- [The type of the result of applying operator*() to the iterator. ]
+ [[link boost_asio.reference.buffered_stream.lowest_layer_type [*lowest_layer_type]]]
+ [The type of the lowest layer. ]
]
[
- [[link boost_asio.reference.buffers_iterator.value_type [*value_type]]]
- [The type of the value pointed to by the iterator. ]
+ [[link boost_asio.reference.buffered_stream.next_layer_type [*next_layer_type]]]
+ [The type of the next layer. ]
]
@@ -48408,136 +48179,123 @@
[[Name][Description]]
[
- [[link boost_asio.reference.buffers_iterator.begin [*begin]]]
- [Construct an iterator representing the beginning of the buffers' data. ]
+ [[link boost_asio.reference.buffered_stream.async_fill [*async_fill]]]
+ [Start an asynchronous fill. ]
]
[
- [[link boost_asio.reference.buffers_iterator.buffers_iterator [*buffers_iterator]]]
- [Default constructor. Creates an iterator in an undefined state. ]
+ [[link boost_asio.reference.buffered_stream.async_flush [*async_flush]]]
+ [Start an asynchronous flush. ]
]
[
- [[link boost_asio.reference.buffers_iterator.end [*end]]]
- [Construct an iterator representing the end of the buffers' data. ]
+ [[link boost_asio.reference.buffered_stream.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator__star_ [*operator *]]]
- [Dereference an iterator. ]
+ [[link boost_asio.reference.buffered_stream.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_plus__plus_ [*operator++]]]
- [Increment operator (prefix).
-
- Increment operator (postfix). ]
+ [[link boost_asio.reference.buffered_stream.buffered_stream [*buffered_stream]]]
+ [Construct, passing the specified argument to initialise the next layer. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_plus__eq_ [*operator+=]]]
- [Addition operator. ]
+ [[link boost_asio.reference.buffered_stream.close [*close]]]
+ [Close the stream. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_minus__minus_ [*operator--]]]
- [Decrement operator (prefix).
+ [[link boost_asio.reference.buffered_stream.fill [*fill]]]
+ [Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- Decrement operator (postfix). ]
- ]
-
- [
- [[link boost_asio.reference.buffers_iterator.operator_minus__eq_ [*operator-=]]]
- [Subtraction operator. ]
- ]
-
- [
- [[link boost_asio.reference.buffers_iterator.operator_arrow_ [*operator->]]]
- [Dereference an iterator. ]
+ Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_lb__rb_ [*operator\[\]]]]
- [Access an individual element. ]
- ]
-
-]
-
-[heading Friends]
-[table
- [[Name][Description]]
+ [[link boost_asio.reference.buffered_stream.flush [*flush]]]
+ [Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
- [
- [[link boost_asio.reference.buffers_iterator.operator_not__eq_ [*operator!=]]]
- [Test two iterators for inequality. ]
+ Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_plus_ [*operator+]]]
- [Addition operator. ]
+ [[link boost_asio.reference.buffered_stream.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_minus_ [*operator-]]]
- [Subtraction operator. ]
+ [[link boost_asio.reference.buffered_stream.in_avail [*in_avail]]]
+ [Determine the amount of data that may be read without blocking. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_lt_ [*operator<]]]
- [Compare two iterators. ]
+ [[link boost_asio.reference.buffered_stream.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_lt__eq_ [*operator<=]]]
- [Compare two iterators. ]
+ [[link boost_asio.reference.buffered_stream.next_layer [*next_layer]]]
+ [Get a reference to the next layer. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_eq__eq_ [*operator==]]]
- [Test two iterators for equality. ]
+ [[link boost_asio.reference.buffered_stream.peek [*peek]]]
+ [Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
+
+ Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_gt_ [*operator>]]]
- [Compare two iterators. ]
+ [[link boost_asio.reference.buffered_stream.read_some [*read_some]]]
+ [Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+
+ Read some data from the stream. Returns the number of bytes read or 0 if an error occurred. ]
]
[
- [[link boost_asio.reference.buffers_iterator.operator_gt__eq_ [*operator>=]]]
- [Compare two iterators. ]
+ [[link boost_asio.reference.buffered_stream.write_some [*write_some]]]
+ [Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
+
+ Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred. ]
]
]
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
+The [link boost_asio.reference.buffered_stream `buffered_stream`] class template can be used to add buffering to the synchronous and asynchronous read and write operations of a stream.
-[section:begin buffers_iterator::begin]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[indexterm2 begin..buffers_iterator]
-Construct an iterator representing the beginning of the buffers' data.
+[*Shared] [*objects:] Unsafe.
- static buffers_iterator begin(
- const BufferSequence & buffers);
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/buffered_stream.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:buffers_iterator buffers_iterator::buffers_iterator]
+[section:async_fill buffered_stream::async_fill]
-[indexterm2 buffers_iterator..buffers_iterator]
-Default constructor. Creates an iterator in an undefined state.
+[indexterm2 async_fill..buffered_stream]
+Start an asynchronous fill.
- buffers_iterator();
+ template<
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_fill(
+ ReadHandler handler);
@@ -48545,35 +48303,35 @@
-[section:difference_type buffers_iterator::difference_type]
-
-[indexterm2 difference_type..buffers_iterator]
-The type used for the distance between two iterators.
-
-
- typedef std::ptrdiff_t difference_type;
-
+[section:async_flush buffered_stream::async_flush]
+[indexterm2 async_flush..buffered_stream]
+Start an asynchronous flush.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ template<
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_flush(
+ WriteHandler handler);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:end buffers_iterator::end]
+[section:async_read_some buffered_stream::async_read_some]
-[indexterm2 end..buffers_iterator]
-Construct an iterator representing the end of the buffers' data.
+[indexterm2 async_read_some..buffered_stream]
+Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
- static buffers_iterator end(
- const BufferSequence & buffers);
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
@@ -48581,117 +48339,119 @@
-[section:iterator_category buffers_iterator::iterator_category]
+[section:async_write_some buffered_stream::async_write_some]
-[indexterm2 iterator_category..buffers_iterator]
-The iterator category.
+[indexterm2 async_write_some..buffered_stream]
+Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
- typedef std::random_access_iterator_tag iterator_category;
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:buffered_stream buffered_stream::buffered_stream]
+[indexterm2 buffered_stream..buffered_stream]
+Construct, passing the specified argument to initialise the next layer.
-[endsect]
+ template<
+ typename Arg>
+ explicit ``[link boost_asio.reference.buffered_stream.buffered_stream.overload1 buffered_stream]``(
+ Arg & a);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.buffered_stream.overload1 more...]]``
+ template<
+ typename Arg>
+ explicit ``[link boost_asio.reference.buffered_stream.buffered_stream.overload2 buffered_stream]``(
+ Arg & a,
+ std::size_t read_buffer_size,
+ std::size_t write_buffer_size);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.buffered_stream.overload2 more...]]``
-[section:operator__star_ buffers_iterator::operator *]
-[indexterm2 operator *..buffers_iterator]
-Dereference an iterator.
+[section:overload1 buffered_stream::buffered_stream (1 of 2 overloads)]
- reference operator *() const;
+Construct, passing the specified argument to initialise the next layer.
+ template<
+ typename Arg>
+ buffered_stream(
+ Arg & a);
-[endsect]
+[endsect]
-[section:operator_not__eq_ buffers_iterator::operator!=]
-[indexterm2 operator!=..buffers_iterator]
-Test two iterators for inequality.
+[section:overload2 buffered_stream::buffered_stream (2 of 2 overloads)]
- friend bool operator!=(
- const buffers_iterator & a,
- const buffers_iterator & b);
+Construct, passing the specified argument to initialise the next layer.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ template<
+ typename Arg>
+ buffered_stream(
+ Arg & a,
+ std::size_t read_buffer_size,
+ std::size_t write_buffer_size);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:operator_plus_ buffers_iterator::operator+]
-
-[indexterm2 operator+..buffers_iterator]
-Addition operator.
-
+[endsect]
- friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus_.overload1 operator+]``(
- const buffers_iterator & iter,
- std::ptrdiff_t difference);
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus_.overload1 more...]]``
+[section:close buffered_stream::close]
- friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus_.overload2 operator+]``(
- std::ptrdiff_t difference,
- const buffers_iterator & iter);
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus_.overload2 more...]]``
+[indexterm2 close..buffered_stream]
+Close the stream.
-[section:overload1 buffers_iterator::operator+ (1 of 2 overloads)]
+ void ``[link boost_asio.reference.buffered_stream.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.buffered_stream.close.overload1 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.buffered_stream.close.overload2 close]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.close.overload2 more...]]``
-Addition operator.
+[section:overload1 buffered_stream::close (1 of 2 overloads)]
- friend buffers_iterator operator+(
- const buffers_iterator & iter,
- std::ptrdiff_t difference);
+Close the stream.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ void close();
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 buffers_iterator::operator+ (2 of 2 overloads)]
-
-
-Addition operator.
-
+[section:overload2 buffered_stream::close (2 of 2 overloads)]
- friend buffers_iterator operator+(
- std::ptrdiff_t difference,
- const buffers_iterator & iter);
+Close the stream.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ boost::system::error_code close(
+ boost::system::error_code & ec);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
@@ -48699,31 +48459,31 @@
[endsect]
-[section:operator_plus__plus_ buffers_iterator::operator++]
+[section:fill buffered_stream::fill]
-[indexterm2 operator++..buffers_iterator]
-Increment operator (prefix).
+[indexterm2 fill..buffered_stream]
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- buffers_iterator & ``[link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload1 operator++]``();
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.buffered_stream.fill.overload1 fill]``();
+ `` [''''»''' [link boost_asio.reference.buffered_stream.fill.overload1 more...]]``
-Increment operator (postfix).
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
- buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload2 operator++]``(
- int );
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload2 more...]]``
+ std::size_t ``[link boost_asio.reference.buffered_stream.fill.overload2 fill]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.fill.overload2 more...]]``
-[section:overload1 buffers_iterator::operator++ (1 of 2 overloads)]
+[section:overload1 buffered_stream::fill (1 of 2 overloads)]
-Increment operator (prefix).
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation. Throws an exception on failure.
- buffers_iterator & operator++();
+ std::size_t fill();
@@ -48731,14 +48491,14 @@
-[section:overload2 buffers_iterator::operator++ (2 of 2 overloads)]
+[section:overload2 buffered_stream::fill (2 of 2 overloads)]
-Increment operator (postfix).
+Fill the buffer with some data. Returns the number of bytes placed in the buffer as a result of the operation, or 0 if an error occurred.
- buffers_iterator operator++(
- int );
+ std::size_t fill(
+ boost::system::error_code & ec);
@@ -48747,108 +48507,89 @@
[endsect]
+[section:flush buffered_stream::flush]
-[section:operator_plus__eq_ buffers_iterator::operator+=]
-
-[indexterm2 operator+=..buffers_iterator]
-Addition operator.
-
-
- buffers_iterator & operator+=(
- std::ptrdiff_t difference);
-
+[indexterm2 flush..buffered_stream]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
-[endsect]
+ std::size_t ``[link boost_asio.reference.buffered_stream.flush.overload1 flush]``();
+ `` [''''»''' [link boost_asio.reference.buffered_stream.flush.overload1 more...]]``
-[section:operator_minus_ buffers_iterator::operator-]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
-[indexterm2 operator-..buffers_iterator]
-Subtraction operator.
+ std::size_t ``[link boost_asio.reference.buffered_stream.flush.overload2 flush]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.flush.overload2 more...]]``
- friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_minus_.overload1 operator-]``(
- const buffers_iterator & iter,
- std::ptrdiff_t difference);
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus_.overload1 more...]]``
- friend std::ptrdiff_t ``[link boost_asio.reference.buffers_iterator.operator_minus_.overload2 operator-]``(
- const buffers_iterator & a,
- const buffers_iterator & b);
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus_.overload2 more...]]``
+[section:overload1 buffered_stream::flush (1 of 2 overloads)]
-[section:overload1 buffers_iterator::operator- (1 of 2 overloads)]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
-Subtraction operator.
+ std::size_t flush();
- friend buffers_iterator operator-(
- const buffers_iterator & iter,
- std::ptrdiff_t difference);
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload2 buffered_stream::flush (2 of 2 overloads)]
-[endsect]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+ std::size_t flush(
+ boost::system::error_code & ec);
-[section:overload2 buffers_iterator::operator- (2 of 2 overloads)]
-Subtraction operator.
+[endsect]
- friend std::ptrdiff_t operator-(
- const buffers_iterator & a,
- const buffers_iterator & b);
+[endsect]
-[heading Requirements]
+[section:get_io_service buffered_stream::get_io_service]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+[indexterm2 get_io_service..buffered_stream]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
-[*Convenience header: ][^boost/asio.hpp]
+ boost::asio::io_service & get_io_service();
-[endsect]
[endsect]
-[section:operator_minus__minus_ buffers_iterator::operator--]
-
-[indexterm2 operator--..buffers_iterator]
-Decrement operator (prefix).
-
- buffers_iterator & ``[link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload1 operator--]``();
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload1 more...]]``
+[section:in_avail buffered_stream::in_avail]
+[indexterm2 in_avail..buffered_stream]
+Determine the amount of data that may be read without blocking.
-Decrement operator (postfix).
+ std::size_t ``[link boost_asio.reference.buffered_stream.in_avail.overload1 in_avail]``();
+ `` [''''»''' [link boost_asio.reference.buffered_stream.in_avail.overload1 more...]]``
- buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload2 operator--]``(
- int );
- `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload2 more...]]``
+ std::size_t ``[link boost_asio.reference.buffered_stream.in_avail.overload2 in_avail]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.in_avail.overload2 more...]]``
-[section:overload1 buffers_iterator::operator-- (1 of 2 overloads)]
+[section:overload1 buffered_stream::in_avail (1 of 2 overloads)]
-Decrement operator (prefix).
+Determine the amount of data that may be read without blocking.
- buffers_iterator & operator--();
+ std::size_t in_avail();
@@ -48856,14 +48597,14 @@
-[section:overload2 buffers_iterator::operator-- (2 of 2 overloads)]
+[section:overload2 buffered_stream::in_avail (2 of 2 overloads)]
-Decrement operator (postfix).
+Determine the amount of data that may be read without blocking.
- buffers_iterator operator--(
- int );
+ std::size_t in_avail(
+ boost::system::error_code & ec);
@@ -48872,29 +48613,30 @@
[endsect]
+[section:lowest_layer buffered_stream::lowest_layer]
-[section:operator_minus__eq_ buffers_iterator::operator-=]
+[indexterm2 lowest_layer..buffered_stream]
+Get a reference to the lowest layer.
-[indexterm2 operator-=..buffers_iterator]
-Subtraction operator.
+ lowest_layer_type & ``[link boost_asio.reference.buffered_stream.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.buffered_stream.lowest_layer.overload1 more...]]``
- buffers_iterator & operator-=(
- std::ptrdiff_t difference);
+Get a const reference to the lowest layer.
-[endsect]
+ const lowest_layer_type & ``[link boost_asio.reference.buffered_stream.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.buffered_stream.lowest_layer.overload2 more...]]``
+[section:overload1 buffered_stream::lowest_layer (1 of 2 overloads)]
-[section:operator_arrow_ buffers_iterator::operator->]
-[indexterm2 operator->..buffers_iterator]
-Dereference an iterator.
+Get a reference to the lowest layer.
- pointer operator->() const;
+ lowest_layer_type & lowest_layer();
@@ -48902,42 +48644,35 @@
-[section:operator_lt_ buffers_iterator::operator<]
+[section:overload2 buffered_stream::lowest_layer (2 of 2 overloads)]
-[indexterm2 operator<..buffers_iterator]
-Compare two iterators.
+Get a const reference to the lowest layer.
- friend bool operator<(
- const buffers_iterator & a,
- const buffers_iterator & b);
+ const lowest_layer_type & lowest_layer() const;
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:lowest_layer_type buffered_stream::lowest_layer_type]
-[section:operator_lt__eq_ buffers_iterator::operator<=]
+[indexterm2 lowest_layer_type..buffered_stream]
+The type of the lowest layer.
-[indexterm2 operator<=..buffers_iterator]
-Compare two iterators.
+ typedef next_layer_type::lowest_layer_type lowest_layer_type;
- friend bool operator<=(
- const buffers_iterator & a,
- const buffers_iterator & b);
[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Header: ][^boost/asio/buffered_stream.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -48946,42 +48681,33 @@
-[section:operator_eq__eq_ buffers_iterator::operator==]
-
-[indexterm2 operator==..buffers_iterator]
-Test two iterators for equality.
-
-
- friend bool operator==(
- const buffers_iterator & a,
- const buffers_iterator & b);
+[section:next_layer buffered_stream::next_layer]
+[indexterm2 next_layer..buffered_stream]
+Get a reference to the next layer.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ next_layer_type & next_layer();
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:operator_gt_ buffers_iterator::operator>]
+[section:next_layer_type buffered_stream::next_layer_type]
-[indexterm2 operator>..buffers_iterator]
-Compare two iterators.
+[indexterm2 next_layer_type..buffered_stream]
+The type of the next layer.
- friend bool operator>(
- const buffers_iterator & a,
- const buffers_iterator & b);
+ typedef boost::remove_reference< Stream >::type next_layer_type;
+
[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Header: ][^boost/asio/buffered_stream.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -48989,343 +48715,361 @@
[endsect]
+[section:peek buffered_stream::peek]
-[section:operator_gt__eq_ buffers_iterator::operator>=]
+[indexterm2 peek..buffered_stream]
+Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
-[indexterm2 operator>=..buffers_iterator]
-Compare two iterators.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.peek.overload1 peek]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.peek.overload1 more...]]``
- friend bool operator>=(
- const buffers_iterator & a,
- const buffers_iterator & b);
+Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.peek.overload2 peek]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.peek.overload2 more...]]``
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload1 buffered_stream::peek (1 of 2 overloads)]
-[endsect]
+Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
-[section:operator_lb__rb_ buffers_iterator::operator\[\]]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t peek(
+ const MutableBufferSequence & buffers);
-[indexterm2 operator\[\]..buffers_iterator]
-Access an individual element.
- reference operator[](
- std::ptrdiff_t difference) const;
+[endsect]
-[endsect]
+[section:overload2 buffered_stream::peek (2 of 2 overloads)]
+Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
-[section:pointer buffers_iterator::pointer]
-[indexterm2 pointer..buffers_iterator]
-The type of the result of applying `operator->()` to the iterator.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t peek(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
- typedef const_or_non_const_ByteType * pointer;
+[endsect]
-If the buffer sequence stores buffer objects that are convertible to [link boost_asio.reference.mutable_buffer `mutable_buffer`], this is a pointer to a non-const ByteType. Otherwise, a pointer to a const ByteType.
+[endsect]
-[heading Requirements]
-
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
+[section:read_some buffered_stream::read_some]
+[indexterm2 read_some..buffered_stream]
+Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.read_some.overload1 read_some]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.read_some.overload1 more...]]``
-[section:reference buffers_iterator::reference]
+Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
-[indexterm2 reference..buffers_iterator]
-The type of the result of applying `operator*()` to the iterator.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.read_some.overload2 read_some]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.read_some.overload2 more...]]``
- typedef const_or_non_const_ByteType & reference;
+[section:overload1 buffered_stream::read_some (1 of 2 overloads)]
-If the buffer sequence stores buffer objects that are convertible to [link boost_asio.reference.mutable_buffer `mutable_buffer`], this is a reference to a non-const ByteType. Otherwise, a reference to a const ByteType.
+Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:value_type buffers_iterator::value_type]
-
-[indexterm2 value_type..buffers_iterator]
-The type of the value pointed to by the iterator.
+[section:overload2 buffered_stream::read_some (2 of 2 overloads)]
- typedef ByteType value_type;
+Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
-[heading Requirements]
-[*Header: ][^boost/asio/buffers_iterator.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:write_some buffered_stream::write_some]
+[indexterm2 write_some..buffered_stream]
+Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
-[endsect]
-[section:connect connect]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.write_some.overload1 write_some]``(
+ const ConstBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_stream.write_some.overload1 more...]]``
-[indexterm1 connect]
-Establishes a socket connection by trying each endpoint in a sequence.
-
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator ``[link boost_asio.reference.connect.overload1 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin);
- `` [''''»''' [link boost_asio.reference.connect.overload1 more...]]``
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
+
template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator ``[link boost_asio.reference.connect.overload2 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_stream.write_some.overload2 write_some]``(
+ const ConstBufferSequence & buffers,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.connect.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.buffered_stream.write_some.overload2 more...]]``
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator ``[link boost_asio.reference.connect.overload3 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end);
- `` [''''»''' [link boost_asio.reference.connect.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator ``[link boost_asio.reference.connect.overload4 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.connect.overload4 more...]]``
+[section:overload1 buffered_stream::write_some (1 of 2 overloads)]
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator ``[link boost_asio.reference.connect.overload5 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- ConnectCondition connect_condition);
- `` [''''»''' [link boost_asio.reference.connect.overload5 more...]]``
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator ``[link boost_asio.reference.connect.overload6 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- ConnectCondition connect_condition,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.connect.overload6 more...]]``
+Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator ``[link boost_asio.reference.connect.overload7 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- ConnectCondition connect_condition);
- `` [''''»''' [link boost_asio.reference.connect.overload7 more...]]``
template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator ``[link boost_asio.reference.connect.overload8 connect]``(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- ConnectCondition connect_condition,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.connect.overload8 more...]]``
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers);
-[heading Requirements]
-[*Header: ][^boost/asio/connect.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:overload1 connect (1 of 8 overloads)]
+[section:overload2 buffered_stream::write_some (2 of 2 overloads)]
-Establishes a socket connection by trying each endpoint in a sequence.
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin);
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers,
+ boost::system::error_code & ec);
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[endsect]
-]
+[endsect]
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+[section:buffered_write_stream buffered_write_stream]
-[heading Exceptions]
-
+Adds buffering to the write-related operations of a stream.
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-]
+ template<
+ typename Stream>
+ class buffered_write_stream :
+ noncopyable
-[heading Remarks]
-
-This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[heading Example]
+ [[link boost_asio.reference.buffered_write_stream.lowest_layer_type [*lowest_layer_type]]]
+ [The type of the lowest layer. ]
+ ]
+ [
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::socket s(io_service);
- boost::asio::connect(s, r.resolve(q));
+ [[link boost_asio.reference.buffered_write_stream.next_layer_type [*next_layer_type]]]
+ [The type of the next layer. ]
+
+ ]
+
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.buffered_write_stream.async_flush [*async_flush]]]
+ [Start an asynchronous flush. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.buffered_write_stream [*buffered_write_stream]]]
+ [Construct, passing the specified argument to initialise the next layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.close [*close]]]
+ [Close the stream. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.flush [*flush]]]
+ [Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
+ Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.in_avail [*in_avail]]]
+ [Determine the amount of data that may be read without blocking. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.next_layer [*next_layer]]]
+ [Get a reference to the next layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.peek [*peek]]]
+ [Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
+ Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.read_some [*read_some]]]
+ [Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
+ Read some data from the stream. Returns the number of bytes read or 0 if an error occurred. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffered_write_stream.write_some [*write_some]]]
+ [Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
-[endsect]
+ Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw. ]
+ ]
+
+]
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.buffered_write_stream.default_buffer_size [*default_buffer_size]]]
+ [The default buffer size. ]
+ ]
-[section:overload2 connect (2 of 8 overloads)]
+]
+The [link boost_asio.reference.buffered_write_stream `buffered_write_stream`] class template can be used to add buffering to the synchronous and asynchronous write operations of a stream.
-Establishes a socket connection by trying each endpoint in a sequence.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- boost::system::error_code & ec);
+[*Shared] [*objects:] Unsafe.
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
-[heading Parameters]
-
+[heading Requirements]
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[*Header: ][^boost/asio/buffered_write_stream.hpp]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[*Convenience header: ][^boost/asio.hpp]
-[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-]
+[section:async_flush buffered_write_stream::async_flush]
+[indexterm2 async_flush..buffered_write_stream]
+Start an asynchronous flush.
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+ template<
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_flush(
+ WriteHandler handler);
-[heading Remarks]
-
-This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
-[heading Example]
-
+[endsect]
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::socket s(io_service);
- boost::system::error_code ec;
- boost::asio::connect(s, r.resolve(q), ec);
- if (ec)
- {
- // An error occurred.
- }
+[section:async_read_some buffered_write_stream::async_read_some]
+[indexterm2 async_read_some..buffered_write_stream]
+Start an asynchronous read. The buffer into which the data will be read must be valid for the lifetime of the asynchronous operation.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
@@ -49333,622 +49077,440 @@
-[section:overload3 connect (3 of 8 overloads)]
-
+[section:async_write_some buffered_write_stream::async_write_some]
-Establishes a socket connection by trying each endpoint in a sequence.
+[indexterm2 async_write_some..buffered_write_stream]
+Start an asynchronous write. The data being written must be valid for the lifetime of the asynchronous operation.
template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end);
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[section:buffered_write_stream buffered_write_stream::buffered_write_stream]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[indexterm2 buffered_write_stream..buffered_write_stream]
+Construct, passing the specified argument to initialise the next layer.
-[[end][An iterator pointing to the end of a sequence of endpoints.]]
-]
+ template<
+ typename Arg>
+ explicit ``[link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload1 buffered_write_stream]``(
+ Arg & a);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload1 more...]]``
+ template<
+ typename Arg>
+ ``[link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload2 buffered_write_stream]``(
+ Arg & a,
+ std::size_t buffer_size);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.buffered_write_stream.overload2 more...]]``
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+[section:overload1 buffered_write_stream::buffered_write_stream (1 of 2 overloads)]
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+Construct, passing the specified argument to initialise the next layer.
-]
+ template<
+ typename Arg>
+ buffered_write_stream(
+ Arg & a);
-[heading Example]
-
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::resolver::iterator i = r.resolve(q), end;
- tcp::socket s(io_service);
- boost::asio::connect(s, i, end);
+[endsect]
+[section:overload2 buffered_write_stream::buffered_write_stream (2 of 2 overloads)]
+Construct, passing the specified argument to initialise the next layer.
-[endsect]
+ template<
+ typename Arg>
+ buffered_write_stream(
+ Arg & a,
+ std::size_t buffer_size);
-[section:overload4 connect (4 of 8 overloads)]
+[endsect]
-Establishes a socket connection by trying each endpoint in a sequence.
+[endsect]
+[section:close buffered_write_stream::close]
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- boost::system::error_code & ec);
+[indexterm2 close..buffered_write_stream]
+Close the stream.
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+ void ``[link boost_asio.reference.buffered_write_stream.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.close.overload1 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.buffered_write_stream.close.overload2 close]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.close.overload2 more...]]``
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[section:overload1 buffered_write_stream::close (1 of 2 overloads)]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[[end][An iterator pointing to the end of a sequence of endpoints.]]
+Close the stream.
-[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-]
+ void close();
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+[endsect]
-[heading Example]
-
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::resolver::iterator i = r.resolve(q), end;
- tcp::socket s(io_service);
- boost::system::error_code ec;
- boost::asio::connect(s, i, end, ec);
- if (ec)
- {
- // An error occurred.
- }
+[section:overload2 buffered_write_stream::close (2 of 2 overloads)]
+Close the stream.
+ boost::system::error_code close(
+ boost::system::error_code & ec);
[endsect]
+[endsect]
-[section:overload5 connect (5 of 8 overloads)]
+[section:default_buffer_size buffered_write_stream::default_buffer_size]
-Establishes a socket connection by trying each endpoint in a sequence.
+[indexterm2 default_buffer_size..buffered_write_stream]
+The default buffer size.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- ConnectCondition connect_condition);
+ static const std::size_t default_buffer_size = implementation_defined;
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[section:flush buffered_write_stream::flush]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[indexterm2 flush..buffered_write_stream]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
-[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
-``
- Iterator connect_condition(
- const boost::system::error_code& ec,
- Iterator next);
-``
-The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
-]
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.flush.overload1 flush]``();
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.flush.overload1 more...]]``
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
-[heading Exceptions]
-
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.flush.overload2 flush]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.flush.overload2 more...]]``
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-]
+[section:overload1 buffered_write_stream::flush (1 of 2 overloads)]
-[heading Remarks]
-
-This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation. Throws an exception on failure.
-[heading Example]
-
-The following connect condition function object can be used to output information about the individual connection attempts:
+ std::size_t flush();
- struct my_connect_condition
- {
- template <typename Iterator>
- Iterator operator()(
- const boost::system::error_code& ec,
- Iterator next)
- {
- if (ec) std::cout << "Error: " << ec.message() << std::endl;
- std::cout << "Trying: " << next->endpoint() << std::endl;
- return next;
- }
- };
-It would be used with the `boost::asio::connect` function as follows:
+[endsect]
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::socket s(io_service);
- tcp::resolver::iterator i = boost::asio::connect(
- s, r.resolve(q), my_connect_condition());
- std::cout << "Connected to: " << i->endpoint() << std::endl;
+[section:overload2 buffered_write_stream::flush (2 of 2 overloads)]
+Flush all data from the buffer to the next layer. Returns the number of bytes written to the next layer on the last write operation, or 0 if an error occurred.
+ std::size_t flush(
+ boost::system::error_code & ec);
-[endsect]
+[endsect]
-[section:overload6 connect (6 of 8 overloads)]
+[endsect]
-Establishes a socket connection by trying each endpoint in a sequence.
+[section:get_io_service buffered_write_stream::get_io_service]
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- ConnectCondition connect_condition,
- boost::system::error_code & ec);
+[indexterm2 get_io_service..buffered_write_stream]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+ boost::asio::io_service & get_io_service();
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[endsect]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
-``
- Iterator connect_condition(
- const boost::system::error_code& ec,
- Iterator next);
-``
-The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
+[section:in_avail buffered_write_stream::in_avail]
-[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+[indexterm2 in_avail..buffered_write_stream]
+Determine the amount of data that may be read without blocking.
-]
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.in_avail.overload1 in_avail]``();
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.in_avail.overload1 more...]]``
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.in_avail.overload2 in_avail]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.in_avail.overload2 more...]]``
-[heading Remarks]
-
-This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
+[section:overload1 buffered_write_stream::in_avail (1 of 2 overloads)]
-[heading Example]
-
-The following connect condition function object can be used to output information about the individual connection attempts:
+Determine the amount of data that may be read without blocking.
- struct my_connect_condition
- {
- template <typename Iterator>
- Iterator operator()(
- const boost::system::error_code& ec,
- Iterator next)
- {
- if (ec) std::cout << "Error: " << ec.message() << std::endl;
- std::cout << "Trying: " << next->endpoint() << std::endl;
- return next;
- }
- };
+ std::size_t in_avail();
-It would be used with the `boost::asio::connect` function as follows:
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::socket s(io_service);
- boost::system::error_code ec;
- tcp::resolver::iterator i = boost::asio::connect(
- s, r.resolve(q), my_connect_condition(), ec);
- if (ec)
- {
- // An error occurred.
- }
- else
- {
- std::cout << "Connected to: " << i->endpoint() << std::endl;
- }
+[endsect]
+[section:overload2 buffered_write_stream::in_avail (2 of 2 overloads)]
+Determine the amount of data that may be read without blocking.
-[endsect]
+ std::size_t in_avail(
+ boost::system::error_code & ec);
-[section:overload7 connect (7 of 8 overloads)]
+[endsect]
-Establishes a socket connection by trying each endpoint in a sequence.
+[endsect]
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- ConnectCondition connect_condition);
+[section:lowest_layer buffered_write_stream::lowest_layer]
+[indexterm2 lowest_layer..buffered_write_stream]
+Get a reference to the lowest layer.
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+ lowest_layer_type & ``[link boost_asio.reference.buffered_write_stream.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.lowest_layer.overload1 more...]]``
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+Get a const reference to the lowest layer.
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[[end][An iterator pointing to the end of a sequence of endpoints.]]
+ const lowest_layer_type & ``[link boost_asio.reference.buffered_write_stream.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.lowest_layer.overload2 more...]]``
-[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
-``
- Iterator connect_condition(
- const boost::system::error_code& ec,
- Iterator next);
-``
-The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
-]
+[section:overload1 buffered_write_stream::lowest_layer (1 of 2 overloads)]
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+Get a reference to the lowest layer.
-[heading Exceptions]
-
+ lowest_layer_type & lowest_layer();
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-]
+[endsect]
-[heading Example]
-
-The following connect condition function object can be used to output information about the individual connection attempts:
- struct my_connect_condition
- {
- template <typename Iterator>
- Iterator operator()(
- const boost::system::error_code& ec,
- Iterator next)
- {
- if (ec) std::cout << "Error: " << ec.message() << std::endl;
- std::cout << "Trying: " << next->endpoint() << std::endl;
- return next;
- }
- };
+[section:overload2 buffered_write_stream::lowest_layer (2 of 2 overloads)]
-It would be used with the `boost::asio::connect` function as follows:
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::resolver::iterator i = r.resolve(q), end;
- tcp::socket s(io_service);
- i = boost::asio::connect(s, i, end, my_connect_condition());
- std::cout << "Connected to: " << i->endpoint() << std::endl;
+Get a const reference to the lowest layer.
+ const lowest_layer_type & lowest_layer() const;
+[endsect]
[endsect]
+[section:lowest_layer_type buffered_write_stream::lowest_layer_type]
-[section:overload8 connect (8 of 8 overloads)]
+[indexterm2 lowest_layer_type..buffered_write_stream]
+The type of the lowest layer.
-Establishes a socket connection by trying each endpoint in a sequence.
+ typedef next_layer_type::lowest_layer_type lowest_layer_type;
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename Iterator,
- typename ConnectCondition>
- Iterator connect(
- basic_socket< Protocol, SocketService > & s,
- Iterator begin,
- Iterator end,
- ConnectCondition connect_condition,
- boost::system::error_code & ec);
+[heading Requirements]
-This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+[*Header: ][^boost/asio/buffered_write_stream.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
-[variablelist
-
-[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[endsect]
-[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[[end][An iterator pointing to the end of a sequence of endpoints.]]
-[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
-``
- Iterator connect_condition(
- const boost::system::error_code& ec,
- Iterator next);
-``
-The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
+[section:next_layer buffered_write_stream::next_layer]
-[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+[indexterm2 next_layer..buffered_write_stream]
+Get a reference to the next layer.
-]
+ next_layer_type & next_layer();
-[heading Return Value]
-
-On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-[heading Example]
-
-The following connect condition function object can be used to output information about the individual connection attempts:
+[endsect]
- struct my_connect_condition
- {
- template <typename Iterator>
- Iterator operator()(
- const boost::system::error_code& ec,
- Iterator next)
- {
- if (ec) std::cout << "Error: " << ec.message() << std::endl;
- std::cout << "Trying: " << next->endpoint() << std::endl;
- return next;
- }
- };
-It would be used with the `boost::asio::connect` function as follows:
+[section:next_layer_type buffered_write_stream::next_layer_type]
- tcp::resolver r(io_service);
- tcp::resolver::query q("host", "service");
- tcp::resolver::iterator i = r.resolve(q), end;
- tcp::socket s(io_service);
- boost::system::error_code ec;
- i = boost::asio::connect(s, i, end, my_connect_condition(), ec);
- if (ec)
- {
- // An error occurred.
- }
- else
- {
- std::cout << "Connected to: " << i->endpoint() << std::endl;
- }
+[indexterm2 next_layer_type..buffered_write_stream]
+The type of the next layer.
+ typedef boost::remove_reference< Stream >::type next_layer_type;
+[heading Requirements]
+[*Header: ][^boost/asio/buffered_write_stream.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:const_buffer const_buffer]
-
-Holds a buffer that cannot be modified.
+[section:peek buffered_write_stream::peek]
+[indexterm2 peek..buffered_write_stream]
+Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
- class const_buffer
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.peek.overload1 peek]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.peek.overload1 more...]]``
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.const_buffer.const_buffer [*const_buffer]]]
- [Construct an empty buffer.
+Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
- Construct a buffer to represent a given memory range.
- Construct a non-modifiable buffer from a modifiable one. ]
- ]
-
-]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.peek.overload2 peek]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.peek.overload2 more...]]``
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.const_buffer.operator_plus_ [*operator+]]]
- [Create a new non-modifiable buffer that is offset from the start of another. ]
- ]
-
-]
+[section:overload1 buffered_write_stream::peek (1 of 2 overloads)]
-The [link boost_asio.reference.const_buffer `const_buffer`] class provides a safe representation of a buffer that cannot be modified. It does not own the underlying data, and so is cheap to copy or assign.
+Peek at the incoming data on the stream. Returns the number of bytes read. Throws an exception on failure.
-[heading Accessing Buffer Contents]
-
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t peek(
+ const MutableBufferSequence & buffers);
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+[endsect]
- boost::asio::const_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
+[section:overload2 buffered_write_stream::peek (2 of 2 overloads)]
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+Peek at the incoming data on the stream. Returns the number of bytes read, or 0 if an error occurred.
-[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t peek(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
-[*Convenience header: ][^boost/asio.hpp]
-[section:const_buffer const_buffer::const_buffer]
-[indexterm2 const_buffer..const_buffer]
-Construct an empty buffer.
+[endsect]
- ``[link boost_asio.reference.const_buffer.const_buffer.overload1 const_buffer]``();
- `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload1 more...]]``
+[endsect]
+[section:read_some buffered_write_stream::read_some]
-Construct a buffer to represent a given memory range.
+[indexterm2 read_some..buffered_write_stream]
+Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
- ``[link boost_asio.reference.const_buffer.const_buffer.overload2 const_buffer]``(
- const void * data,
- std::size_t size);
- `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.read_some.overload1 read_some]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.read_some.overload1 more...]]``
-Construct a non-modifiable buffer from a modifiable one.
+Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
- ``[link boost_asio.reference.const_buffer.const_buffer.overload3 const_buffer]``(
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload3 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.read_some.overload2 read_some]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.read_some.overload2 more...]]``
-[section:overload1 const_buffer::const_buffer (1 of 3 overloads)]
+[section:overload1 buffered_write_stream::read_some (1 of 2 overloads)]
-Construct an empty buffer.
+Read some data from the stream. Returns the number of bytes read. Throws an exception on failure.
- const_buffer();
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers);
@@ -49956,116 +49518,182 @@
-[section:overload2 const_buffer::const_buffer (2 of 3 overloads)]
+[section:overload2 buffered_write_stream::read_some (2 of 2 overloads)]
-Construct a buffer to represent a given memory range.
+Read some data from the stream. Returns the number of bytes read or 0 if an error occurred.
- const_buffer(
- const void * data,
- std::size_t size);
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
[endsect]
+[endsect]
-[section:overload3 const_buffer::const_buffer (3 of 3 overloads)]
+[section:write_some buffered_write_stream::write_some]
+[indexterm2 write_some..buffered_write_stream]
+Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
-Construct a non-modifiable buffer from a modifiable one.
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.write_some.overload1 write_some]``(
+ const ConstBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.write_some.overload1 more...]]``
- const_buffer(
- const mutable_buffer & b);
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.buffered_write_stream.write_some.overload2 write_some]``(
+ const ConstBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.buffered_write_stream.write_some.overload2 more...]]``
-[endsect]
+[section:overload1 buffered_write_stream::write_some (1 of 2 overloads)]
-[section:operator_plus_ const_buffer::operator+]
-[indexterm2 operator+..const_buffer]
-Create a new non-modifiable buffer that is offset from the start of another.
+Write the given data to the stream. Returns the number of bytes written. Throws an exception on failure.
- const_buffer ``[link boost_asio.reference.const_buffer.operator_plus_.overload1 operator+]``(
- const const_buffer & b,
- std::size_t start);
- `` [''''»''' [link boost_asio.reference.const_buffer.operator_plus_.overload1 more...]]``
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers);
- const_buffer ``[link boost_asio.reference.const_buffer.operator_plus_.overload2 operator+]``(
- std::size_t start,
- const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.const_buffer.operator_plus_.overload2 more...]]``
-[section:overload1 const_buffer::operator+ (1 of 2 overloads)]
+[endsect]
-Create a new non-modifiable buffer that is offset from the start of another.
+[section:overload2 buffered_write_stream::write_some (2 of 2 overloads)]
- const_buffer operator+(
- const const_buffer & b,
- std::size_t start);
+Write the given data to the stream. Returns the number of bytes written, or 0 if an error occurred and the error handler did not throw.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers,
+ boost::system::error_code & ec);
-[section:overload2 const_buffer::operator+ (2 of 2 overloads)]
+[endsect]
-Create a new non-modifiable buffer that is offset from the start of another.
+[endsect]
- const_buffer operator+(
- std::size_t start,
- const const_buffer & b);
+[endsect]
+[section:buffers_begin buffers_begin]
-[endsect]
+[indexterm1 buffers_begin]
+Construct an iterator representing the beginning of the buffers' data.
-[endsect]
+ template<
+ typename BufferSequence>
+ buffers_iterator< BufferSequence > buffers_begin(
+ const BufferSequence & buffers);
-[endsect]
+[heading Requirements]
-[section:const_buffers_1 const_buffers_1]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-Adapts a single non-modifiable buffer so that it meets the requirements of the ConstBufferSequence concept.
+[endsect]
- class const_buffers_1 :
- public const_buffer
-[heading Types]
-[table
- [[Name][Description]]
+[section:buffers_end buffers_end]
- [
+[indexterm1 buffers_end]
+Construct an iterator representing the end of the buffers' data.
- [[link boost_asio.reference.const_buffers_1.const_iterator [*const_iterator]]]
- [A random-access iterator type that may be used to read elements. ]
+
+ template<
+ typename BufferSequence>
+ buffers_iterator< BufferSequence > buffers_end(
+ const BufferSequence & buffers);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:buffers_iterator buffers_iterator]
+
+
+A random access iterator over the bytes in a buffer sequence.
+
+
+ template<
+ typename BufferSequence,
+ typename ByteType = char>
+ class buffers_iterator
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.buffers_iterator.difference_type [*difference_type]]]
+ [The type used for the distance between two iterators. ]
]
[
- [[link boost_asio.reference.const_buffers_1.value_type [*value_type]]]
- [The type for each element in the list of buffers. ]
+ [[link boost_asio.reference.buffers_iterator.iterator_category [*iterator_category]]]
+ [The iterator category. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.buffers_iterator.pointer [*pointer]]]
+ [The type of the result of applying operator->() to the iterator. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.buffers_iterator.reference [*reference]]]
+ [The type of the result of applying operator*() to the iterator. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.buffers_iterator.value_type [*value_type]]]
+ [The type of the value pointed to by the iterator. ]
]
@@ -50076,121 +49704,228 @@
[[Name][Description]]
[
- [[link boost_asio.reference.const_buffers_1.begin [*begin]]]
- [Get a random-access iterator to the first element. ]
+ [[link boost_asio.reference.buffers_iterator.begin [*begin]]]
+ [Construct an iterator representing the beginning of the buffers' data. ]
]
[
- [[link boost_asio.reference.const_buffers_1.const_buffers_1 [*const_buffers_1]]]
- [Construct to represent a given memory range.
+ [[link boost_asio.reference.buffers_iterator.buffers_iterator [*buffers_iterator]]]
+ [Default constructor. Creates an iterator in an undefined state. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.end [*end]]]
+ [Construct an iterator representing the end of the buffers' data. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator__star_ [*operator *]]]
+ [Dereference an iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_plus__plus_ [*operator++]]]
+ [Increment operator (prefix).
- Construct to represent a single non-modifiable buffer. ]
+ Increment operator (postfix). ]
]
[
- [[link boost_asio.reference.const_buffers_1.end [*end]]]
- [Get a random-access iterator for one past the last element. ]
+ [[link boost_asio.reference.buffers_iterator.operator_plus__eq_ [*operator+=]]]
+ [Addition operator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_minus__minus_ [*operator--]]]
+ [Decrement operator (prefix).
+
+ Decrement operator (postfix). ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_minus__eq_ [*operator-=]]]
+ [Subtraction operator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_arrow_ [*operator->]]]
+ [Dereference an iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_lb__rb_ [*operator\[\]]]]
+ [Access an individual element. ]
]
]
-[heading Related Functions]
+[heading Friends]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.const_buffers_1.operator_plus_ [*operator+]]]
- [Create a new non-modifiable buffer that is offset from the start of another. ]
+ [[link boost_asio.reference.buffers_iterator.operator_not__eq_ [*operator!=]]]
+ [Test two iterators for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_plus_ [*operator+]]]
+ [Addition operator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_minus_ [*operator-]]]
+ [Subtraction operator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_lt_ [*operator<]]]
+ [Compare two iterators. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_lt__eq_ [*operator<=]]]
+ [Compare two iterators. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_eq__eq_ [*operator==]]]
+ [Test two iterators for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_gt_ [*operator>]]]
+ [Compare two iterators. ]
+ ]
+
+ [
+ [[link boost_asio.reference.buffers_iterator.operator_gt__eq_ [*operator>=]]]
+ [Compare two iterators. ]
]
]
[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:begin const_buffers_1::begin]
+[section:begin buffers_iterator::begin]
-[indexterm2 begin..const_buffers_1]
-Get a random-access iterator to the first element.
+[indexterm2 begin..buffers_iterator]
+Construct an iterator representing the beginning of the buffers' data.
- const_iterator begin() const;
+ static buffers_iterator begin(
+ const BufferSequence & buffers);
[endsect]
-[section:const_buffers_1 const_buffers_1::const_buffers_1]
-[indexterm2 const_buffers_1..const_buffers_1]
-Construct to represent a given memory range.
+[section:buffers_iterator buffers_iterator::buffers_iterator]
+[indexterm2 buffers_iterator..buffers_iterator]
+Default constructor. Creates an iterator in an undefined state.
- ``[link boost_asio.reference.const_buffers_1.const_buffers_1.overload1 const_buffers_1]``(
- const void * data,
- std::size_t size);
- `` [''''»''' [link boost_asio.reference.const_buffers_1.const_buffers_1.overload1 more...]]``
+ buffers_iterator();
-Construct to represent a single non-modifiable buffer.
- explicit ``[link boost_asio.reference.const_buffers_1.const_buffers_1.overload2 const_buffers_1]``(
- const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.const_buffers_1.const_buffers_1.overload2 more...]]``
+[endsect]
-[section:overload1 const_buffers_1::const_buffers_1 (1 of 2 overloads)]
+[section:difference_type buffers_iterator::difference_type]
+
+[indexterm2 difference_type..buffers_iterator]
+The type used for the distance between two iterators.
-Construct to represent a given memory range.
+ typedef std::ptrdiff_t difference_type;
- const_buffers_1(
- const void * data,
- std::size_t size);
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
[endsect]
-[section:overload2 const_buffers_1::const_buffers_1 (2 of 2 overloads)]
+[section:end buffers_iterator::end]
+[indexterm2 end..buffers_iterator]
+Construct an iterator representing the end of the buffers' data.
-Construct to represent a single non-modifiable buffer.
+
+ static buffers_iterator end(
+ const BufferSequence & buffers);
- const_buffers_1(
- const const_buffer & b);
+[endsect]
+
+
+
+[section:iterator_category buffers_iterator::iterator_category]
+
+[indexterm2 iterator_category..buffers_iterator]
+The iterator category.
+
+
+ typedef std::random_access_iterator_tag iterator_category;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+
+[section:operator__star_ buffers_iterator::operator *]
+
+[indexterm2 operator *..buffers_iterator]
+Dereference an iterator.
+
+
+ reference operator *() const;
+
+
+
[endsect]
-[section:const_iterator const_buffers_1::const_iterator]
-[indexterm2 const_iterator..const_buffers_1]
-A random-access iterator type that may be used to read elements.
+[section:operator_not__eq_ buffers_iterator::operator!=]
+[indexterm2 operator!=..buffers_iterator]
+Test two iterators for inequality.
- typedef const const_buffer * const_iterator;
+ friend bool operator!=(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -50198,49 +49933,93 @@
[endsect]
+[section:operator_plus_ buffers_iterator::operator+]
-[section:end const_buffers_1::end]
+[indexterm2 operator+..buffers_iterator]
+Addition operator.
-[indexterm2 end..const_buffers_1]
-Get a random-access iterator for one past the last element.
+ friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus_.overload1 operator+]``(
+ const buffers_iterator & iter,
+ std::ptrdiff_t difference);
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus_.overload1 more...]]``
+
+ friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus_.overload2 operator+]``(
+ std::ptrdiff_t difference,
+ const buffers_iterator & iter);
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus_.overload2 more...]]``
+
+
+[section:overload1 buffers_iterator::operator+ (1 of 2 overloads)]
+
+
+Addition operator.
- const_iterator end() const;
+ friend buffers_iterator operator+(
+ const buffers_iterator & iter,
+ std::ptrdiff_t difference);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:operator_plus_ const_buffers_1::operator+]
-[indexterm2 operator+..const_buffers_1]
-Create a new non-modifiable buffer that is offset from the start of another.
+[section:overload2 buffers_iterator::operator+ (2 of 2 overloads)]
- const_buffer ``[link boost_asio.reference.const_buffers_1.operator_plus_.overload1 operator+]``(
- const const_buffer & b,
- std::size_t start);
- `` [''''»''' [link boost_asio.reference.const_buffers_1.operator_plus_.overload1 more...]]``
+Addition operator.
- const_buffer ``[link boost_asio.reference.const_buffers_1.operator_plus_.overload2 operator+]``(
- std::size_t start,
- const const_buffer & b);
- `` [''''»''' [link boost_asio.reference.const_buffers_1.operator_plus_.overload2 more...]]``
+ friend buffers_iterator operator+(
+ std::ptrdiff_t difference,
+ const buffers_iterator & iter);
-[section:overload1 const_buffers_1::operator+ (1 of 2 overloads)]
+[heading Requirements]
-['Inherited from const_buffer.]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-Create a new non-modifiable buffer that is offset from the start of another.
+[endsect]
+
+
+[endsect]
+
+[section:operator_plus__plus_ buffers_iterator::operator++]
+
+[indexterm2 operator++..buffers_iterator]
+Increment operator (prefix).
+
+
+ buffers_iterator & ``[link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload1 operator++]``();
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload1 more...]]``
- const_buffer operator+(
- const const_buffer & b,
- std::size_t start);
+
+Increment operator (postfix).
+
+
+ buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload2 operator++]``(
+ int );
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_plus__plus_.overload2 more...]]``
+
+
+[section:overload1 buffers_iterator::operator++ (1 of 2 overloads)]
+
+
+Increment operator (prefix).
+
+
+ buffers_iterator & operator++();
@@ -50248,86 +50027,90 @@
-[section:overload2 const_buffers_1::operator+ (2 of 2 overloads)]
+[section:overload2 buffers_iterator::operator++ (2 of 2 overloads)]
-['Inherited from const_buffer.]
+Increment operator (postfix).
-Create a new non-modifiable buffer that is offset from the start of another.
+ buffers_iterator operator++(
+ int );
- const_buffer operator+(
- std::size_t start,
- const const_buffer & b);
+[endsect]
[endsect]
+[section:operator_plus__eq_ buffers_iterator::operator+=]
+
+[indexterm2 operator+=..buffers_iterator]
+Addition operator.
+
+
+ buffers_iterator & operator+=(
+ std::ptrdiff_t difference);
+
+
+
[endsect]
-[section:value_type const_buffers_1::value_type]
+[section:operator_minus_ buffers_iterator::operator-]
-[indexterm2 value_type..const_buffers_1]
-The type for each element in the list of buffers.
+[indexterm2 operator-..buffers_iterator]
+Subtraction operator.
- typedef const_buffer value_type;
+ friend buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_minus_.overload1 operator-]``(
+ const buffers_iterator & iter,
+ std::ptrdiff_t difference);
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus_.overload1 more...]]``
+ friend std::ptrdiff_t ``[link boost_asio.reference.buffers_iterator.operator_minus_.overload2 operator-]``(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus_.overload2 more...]]``
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.const_buffer.const_buffer [*const_buffer]]]
- [Construct an empty buffer.
+[section:overload1 buffers_iterator::operator- (1 of 2 overloads)]
- Construct a buffer to represent a given memory range.
- Construct a non-modifiable buffer from a modifiable one. ]
- ]
-
-]
+Subtraction operator.
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.const_buffer.operator_plus_ [*operator+]]]
- [Create a new non-modifiable buffer that is offset from the start of another. ]
- ]
-
-]
+ friend buffers_iterator operator-(
+ const buffers_iterator & iter,
+ std::ptrdiff_t difference);
-The [link boost_asio.reference.const_buffer `const_buffer`] class provides a safe representation of a buffer that cannot be modified. It does not own the underlying data, and so is cheap to copy or assign.
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffers_iterator.hpp]
-[heading Accessing Buffer Contents]
-
+[*Convenience header: ][^boost/asio.hpp]
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+[endsect]
- boost::asio::const_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
+[section:overload2 buffers_iterator::operator- (2 of 2 overloads)]
+Subtraction operator.
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+ friend std::ptrdiff_t operator-(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -50335,408 +50118,204 @@
[endsect]
+[endsect]
+
+[section:operator_minus__minus_ buffers_iterator::operator--]
+
+[indexterm2 operator--..buffers_iterator]
+Decrement operator (prefix).
+
+
+ buffers_iterator & ``[link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload1 operator--]``();
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload1 more...]]``
+
+
+Decrement operator (postfix).
+
+
+ buffers_iterator ``[link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload2 operator--]``(
+ int );
+ `` [''''»''' [link boost_asio.reference.buffers_iterator.operator_minus__minus_.overload2 more...]]``
+
+
+[section:overload1 buffers_iterator::operator-- (1 of 2 overloads)]
+
+
+Decrement operator (prefix).
+
+
+ buffers_iterator & operator--();
+
+
[endsect]
-[section:datagram_socket_service datagram_socket_service]
-Default service implementation for a datagram socket.
+[section:overload2 buffers_iterator::operator-- (2 of 2 overloads)]
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class datagram_socket_service :
- public io_service::service
+Decrement operator (postfix).
-[heading Types]
-[table
- [[Name][Description]]
+ buffers_iterator operator--(
+ int );
- [
- [[link boost_asio.reference.datagram_socket_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.datagram_socket_service.implementation_type [*implementation_type]]]
- [The type of a datagram socket. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.datagram_socket_service.native_handle_type [*native_handle_type]]]
- [The native socket type. ]
-
- ]
- [
+[section:operator_minus__eq_ buffers_iterator::operator-=]
- [[link boost_asio.reference.datagram_socket_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native socket type. ]
-
- ]
+[indexterm2 operator-=..buffers_iterator]
+Subtraction operator.
- [
- [[link boost_asio.reference.datagram_socket_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+ buffers_iterator & operator-=(
+ std::ptrdiff_t difference);
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.datagram_socket_service.assign [*assign]]]
- [Assign an existing native socket to a datagram socket. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.async_receive [*async_receive]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.async_receive_from [*async_receive_from]]]
- [Start an asynchronous receive that will get the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.async_send [*async_send]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.async_send_to [*async_send_to]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.bind [*bind]]]
- []
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.close [*close]]]
- [Close a datagram socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.connect [*connect]]]
- [Connect the datagram socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.construct [*construct]]]
- [Construct a new datagram socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.datagram_socket_service [*datagram_socket_service]]]
- [Construct a new datagram socket service for the specified io_service. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.destroy [*destroy]]]
- [Destroy a datagram socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.get_option [*get_option]]]
- [Get a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.local_endpoint [*local_endpoint]]]
- [Get the local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.move_assign [*move_assign]]]
- [Move-assign from another datagram socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.move_construct [*move_construct]]]
- [Move-construct a new datagram socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.native_handle [*native_handle]]]
- [Get the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
-
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
+[endsect]
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.open [*open]]]
- []
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.receive [*receive]]]
- [Receive some data from the peer. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.receive_from [*receive_from]]]
- [Receive a datagram with the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.send [*send]]]
- [Send the given data to the peer. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.send_to [*send_to]]]
- [Send a datagram to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.set_option [*set_option]]]
- [Set a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.datagram_socket_service.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
-]
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.datagram_socket_service.id [*id]]]
- [The unique service identifier. ]
- ]
+[section:operator_arrow_ buffers_iterator::operator->]
-]
+[indexterm2 operator->..buffers_iterator]
+Dereference an iterator.
-[heading Requirements]
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
+ pointer operator->() const;
-[*Convenience header: ][^boost/asio.hpp]
-[section:assign datagram_socket_service::assign]
+[endsect]
-[indexterm2 assign..datagram_socket_service]
-Assign an existing native socket to a datagram socket.
- boost::system::error_code assign(
- implementation_type & impl,
- const protocol_type & protocol,
- const native_handle_type & native_socket,
- boost::system::error_code & ec);
+[section:operator_lt_ buffers_iterator::operator<]
+[indexterm2 operator<..buffers_iterator]
+Compare two iterators.
-[endsect]
+ friend bool operator<(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
+[heading Requirements]
-[section:async_connect datagram_socket_service::async_connect]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
-[indexterm2 async_connect..datagram_socket_service]
-Start an asynchronous connect.
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
- void async_connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- ConnectHandler handler);
+[endsect]
-[endsect]
+[section:operator_lt__eq_ buffers_iterator::operator<=]
+[indexterm2 operator<=..buffers_iterator]
+Compare two iterators.
-[section:async_receive datagram_socket_service::async_receive]
+ friend bool operator<=(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
-[indexterm2 async_receive..datagram_socket_service]
-Start an asynchronous receive.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- ReadHandler handler);
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:async_receive_from datagram_socket_service::async_receive_from]
+[section:operator_eq__eq_ buffers_iterator::operator==]
-[indexterm2 async_receive_from..datagram_socket_service]
-Start an asynchronous receive that will get the endpoint of the sender.
+[indexterm2 operator==..buffers_iterator]
+Test two iterators for equality.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive_from(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- endpoint_type & sender_endpoint,
- socket_base::message_flags flags,
- ReadHandler handler);
+ friend bool operator==(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:async_send datagram_socket_service::async_send]
+[endsect]
-[indexterm2 async_send..datagram_socket_service]
-Start an asynchronous send.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- WriteHandler handler);
+[section:operator_gt_ buffers_iterator::operator>]
+[indexterm2 operator>..buffers_iterator]
+Compare two iterators.
-[endsect]
+ friend bool operator>(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
+[heading Requirements]
-[section:async_send_to datagram_socket_service::async_send_to]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
-[indexterm2 async_send_to..datagram_socket_service]
-Start an asynchronous send.
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send_to(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- const endpoint_type & destination,
- socket_base::message_flags flags,
- WriteHandler handler);
+[endsect]
-[endsect]
+[section:operator_gt__eq_ buffers_iterator::operator>=]
+[indexterm2 operator>=..buffers_iterator]
+Compare two iterators.
-[section:at_mark datagram_socket_service::at_mark]
+ friend bool operator>=(
+ const buffers_iterator & a,
+ const buffers_iterator & b);
-[indexterm2 at_mark..datagram_socket_service]
-Determine whether the socket is at the out-of-band data mark.
+[heading Requirements]
- bool at_mark(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:available datagram_socket_service::available]
+[section:operator_lb__rb_ buffers_iterator::operator\[\]]
-[indexterm2 available..datagram_socket_service]
-Determine the number of bytes available for reading.
+[indexterm2 operator\[\]..buffers_iterator]
+Access an individual element.
- std::size_t available(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+ reference operator[](
+ std::ptrdiff_t difference) const;
@@ -50744,165 +50323,238 @@
-[section:bind datagram_socket_service::bind]
-
-[indexterm2 bind..datagram_socket_service]
-
- boost::system::error_code bind(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
-
+[section:pointer buffers_iterator::pointer]
+[indexterm2 pointer..buffers_iterator]
+The type of the result of applying `operator->()` to the iterator.
-[endsect]
+ typedef const_or_non_const_ByteType * pointer;
-[section:cancel datagram_socket_service::cancel]
-[indexterm2 cancel..datagram_socket_service]
-Cancel all asynchronous operations associated with the socket.
+If the buffer sequence stores buffer objects that are convertible to [link boost_asio.reference.mutable_buffer `mutable_buffer`], this is a pointer to a non-const ByteType. Otherwise, a pointer to a const ByteType.
+[heading Requirements]
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:close datagram_socket_service::close]
+[section:reference buffers_iterator::reference]
-[indexterm2 close..datagram_socket_service]
-Close a datagram socket implementation.
+[indexterm2 reference..buffers_iterator]
+The type of the result of applying `operator*()` to the iterator.
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
+ typedef const_or_non_const_ByteType & reference;
-[endsect]
+If the buffer sequence stores buffer objects that are convertible to [link boost_asio.reference.mutable_buffer `mutable_buffer`], this is a reference to a non-const ByteType. Otherwise, a reference to a const ByteType.
+[heading Requirements]
+[*Header: ][^boost/asio/buffers_iterator.hpp]
-[section:connect datagram_socket_service::connect]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 connect..datagram_socket_service]
-Connect the datagram socket to the specified endpoint.
+[endsect]
- boost::system::error_code connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- boost::system::error_code & ec);
+[section:value_type buffers_iterator::value_type]
-[endsect]
+[indexterm2 value_type..buffers_iterator]
+The type of the value pointed to by the iterator.
+ typedef ByteType value_type;
-[section:construct datagram_socket_service::construct]
-[indexterm2 construct..datagram_socket_service]
-Construct a new datagram socket implementation.
+[heading Requirements]
- void construct(
- implementation_type & impl);
+[*Header: ][^boost/asio/buffers_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:datagram_socket_service datagram_socket_service::datagram_socket_service]
+[endsect]
-[indexterm2 datagram_socket_service..datagram_socket_service]
-Construct a new datagram socket service for the specified [link boost_asio.reference.io_service `io_service`].
+[section:connect connect]
+[indexterm1 connect]
+Establishes a socket connection by trying each endpoint in a sequence.
- datagram_socket_service(
- boost::asio::io_service & io_service);
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator ``[link boost_asio.reference.connect.overload1 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin);
+ `` [''''»''' [link boost_asio.reference.connect.overload1 more...]]``
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator ``[link boost_asio.reference.connect.overload2 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.connect.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator ``[link boost_asio.reference.connect.overload3 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end);
+ `` [''''»''' [link boost_asio.reference.connect.overload3 more...]]``
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator ``[link boost_asio.reference.connect.overload4 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.connect.overload4 more...]]``
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator ``[link boost_asio.reference.connect.overload5 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ ConnectCondition connect_condition);
+ `` [''''»''' [link boost_asio.reference.connect.overload5 more...]]``
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator ``[link boost_asio.reference.connect.overload6 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ ConnectCondition connect_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.connect.overload6 more...]]``
-[section:destroy datagram_socket_service::destroy]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator ``[link boost_asio.reference.connect.overload7 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ ConnectCondition connect_condition);
+ `` [''''»''' [link boost_asio.reference.connect.overload7 more...]]``
-[indexterm2 destroy..datagram_socket_service]
-Destroy a datagram socket implementation.
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator ``[link boost_asio.reference.connect.overload8 connect]``(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ ConnectCondition connect_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.connect.overload8 more...]]``
+[heading Requirements]
- void destroy(
- implementation_type & impl);
+[*Header: ][^boost/asio/connect.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:overload1 connect (1 of 8 overloads)]
+Establishes a socket connection by trying each endpoint in a sequence.
-[section:endpoint_type datagram_socket_service::endpoint_type]
-[indexterm2 endpoint_type..datagram_socket_service]
-The endpoint type.
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin);
- typedef Protocol::endpoint endpoint_type;
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+[heading Parameters]
+
-[heading Requirements]
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[*Convenience header: ][^boost/asio.hpp]
+]
-[endsect]
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
+[heading Exceptions]
+
-[section:get_io_service datagram_socket_service::get_io_service]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+]
-['Inherited from io_service.]
-[indexterm2 get_io_service..datagram_socket_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[heading Remarks]
+
+This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
- boost::asio::io_service & get_io_service();
-
-
-
-[endsect]
+[heading Example]
+
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::socket s(io_service);
+ boost::asio::connect(s, r.resolve(q));
-[section:get_option datagram_socket_service::get_option]
-[indexterm2 get_option..datagram_socket_service]
-Get a socket option.
- template<
- typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSocketOption & option,
- boost::system::error_code & ec) const;
@@ -50910,53 +50562,66 @@
-[section:id datagram_socket_service::id]
-
-[indexterm2 id..datagram_socket_service]
-The unique service identifier.
+[section:overload2 connect (2 of 8 overloads)]
- static boost::asio::io_service::id id;
+Establishes a socket connection by trying each endpoint in a sequence.
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ boost::system::error_code & ec);
-[endsect]
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
-[section:implementation_type datagram_socket_service::implementation_type]
+[heading Parameters]
+
-[indexterm2 implementation_type..datagram_socket_service]
-The type of a datagram socket.
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
- typedef implementation_defined implementation_type;
+[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+]
-[heading Requirements]
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Remarks]
+
+This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
-[endsect]
+[heading Example]
+
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::socket s(io_service);
+ boost::system::error_code ec;
+ boost::asio::connect(s, r.resolve(q), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
-[section:io_control datagram_socket_service::io_control]
-[indexterm2 io_control..datagram_socket_service]
-Perform an IO control command on the socket.
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- implementation_type & impl,
- IoControlCommand & command,
- boost::system::error_code & ec);
@@ -50964,299 +50629,423 @@
-[section:is_open datagram_socket_service::is_open]
+[section:overload3 connect (3 of 8 overloads)]
-[indexterm2 is_open..datagram_socket_service]
-Determine whether the socket is open.
+Establishes a socket connection by trying each endpoint in a sequence.
- bool is_open(
- const implementation_type & impl) const;
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end);
-[endsect]
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
+[heading Parameters]
+
-[section:local_endpoint datagram_socket_service::local_endpoint]
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[indexterm2 local_endpoint..datagram_socket_service]
-Get the local endpoint.
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[[end][An iterator pointing to the end of a sequence of endpoints.]]
- endpoint_type local_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+]
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-[section:move_assign datagram_socket_service::move_assign]
+]
-[indexterm2 move_assign..datagram_socket_service]
-Move-assign from another datagram socket implementation.
+[heading Example]
+
- void move_assign(
- implementation_type & impl,
- datagram_socket_service & other_service,
- implementation_type & other_impl);
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::resolver::iterator i = r.resolve(q), end;
+ tcp::socket s(io_service);
+ boost::asio::connect(s, i, end);
-[endsect]
-[section:move_construct datagram_socket_service::move_construct]
-[indexterm2 move_construct..datagram_socket_service]
-Move-construct a new datagram socket implementation.
+[endsect]
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+[section:overload4 connect (4 of 8 overloads)]
-[endsect]
+Establishes a socket connection by trying each endpoint in a sequence.
-[section:native datagram_socket_service::native]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ boost::system::error_code & ec);
-[indexterm2 native..datagram_socket_service]
-(Deprecated: Use `native_handle()`.) Get the native socket implementation.
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
- native_type native(
- implementation_type & impl);
+[heading Parameters]
+
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[endsect]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[[end][An iterator pointing to the end of a sequence of endpoints.]]
+[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-[section:native_handle datagram_socket_service::native_handle]
+]
-[indexterm2 native_handle..datagram_socket_service]
-Get the native socket implementation.
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
- native_handle_type native_handle(
- implementation_type & impl);
+[heading Example]
+
-[endsect]
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::resolver::iterator i = r.resolve(q), end;
+ tcp::socket s(io_service);
+ boost::system::error_code ec;
+ boost::asio::connect(s, i, end, ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
-[section:native_handle_type datagram_socket_service::native_handle_type]
-[indexterm2 native_handle_type..datagram_socket_service]
-The native socket type.
- typedef implementation_defined native_handle_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
+[section:overload5 connect (5 of 8 overloads)]
-[*Convenience header: ][^boost/asio.hpp]
+Establishes a socket connection by trying each endpoint in a sequence.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ ConnectCondition connect_condition);
-[section:native_non_blocking datagram_socket_service::native_non_blocking]
-[indexterm2 native_non_blocking..datagram_socket_service]
-Gets the non-blocking mode of the native socket implementation.
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
- bool ``[link boost_asio.reference.datagram_socket_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.datagram_socket_service.native_non_blocking.overload1 more...]]``
+[heading Parameters]
+
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-Sets the non-blocking mode of the native socket implementation.
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
+``
+ Iterator connect_condition(
+ const boost::system::error_code& ec,
+ Iterator next);
+``
+The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
- boost::system::error_code ``[link boost_asio.reference.datagram_socket_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.datagram_socket_service.native_non_blocking.overload2 more...]]``
+]
-[section:overload1 datagram_socket_service::native_non_blocking (1 of 2 overloads)]
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-Gets the non-blocking mode of the native socket implementation.
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
- bool native_non_blocking(
- const implementation_type & impl) const;
+]
+[heading Remarks]
+
+This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
-[endsect]
+[heading Example]
+
+The following connect condition function object can be used to output information about the individual connection attempts:
+ struct my_connect_condition
+ {
+ template <typename Iterator>
+ Iterator operator()(
+ const boost::system::error_code& ec,
+ Iterator next)
+ {
+ if (ec) std::cout << "Error: " << ec.message() << std::endl;
+ std::cout << "Trying: " << next->endpoint() << std::endl;
+ return next;
+ }
+ };
-[section:overload2 datagram_socket_service::native_non_blocking (2 of 2 overloads)]
+It would be used with the `boost::asio::connect` function as follows:
-Sets the non-blocking mode of the native socket implementation.
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::socket s(io_service);
+ tcp::resolver::iterator i = boost::asio::connect(
+ s, r.resolve(q), my_connect_condition());
+ std::cout << "Connected to: " << i->endpoint() << std::endl;
- boost::system::error_code native_non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
-[endsect]
[endsect]
-[section:native_type datagram_socket_service::native_type]
-
-[indexterm2 native_type..datagram_socket_service]
-(Deprecated: Use native\_handle\_type.) The native socket type.
-
-
- typedef implementation_defined native_type;
+[section:overload6 connect (6 of 8 overloads)]
-[heading Requirements]
+Establishes a socket connection by trying each endpoint in a sequence.
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ ConnectCondition connect_condition,
+ boost::system::error_code & ec);
-[endsect]
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
-[section:non_blocking datagram_socket_service::non_blocking]
+[heading Parameters]
+
-[indexterm2 non_blocking..datagram_socket_service]
-Gets the non-blocking mode of the socket.
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
- bool ``[link boost_asio.reference.datagram_socket_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.datagram_socket_service.non_blocking.overload1 more...]]``
+[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
+``
+ Iterator connect_condition(
+ const boost::system::error_code& ec,
+ Iterator next);
+``
+The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
+[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-Sets the non-blocking mode of the socket.
+]
- boost::system::error_code ``[link boost_asio.reference.datagram_socket_service.non_blocking.overload2 non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.datagram_socket_service.non_blocking.overload2 more...]]``
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-[section:overload1 datagram_socket_service::non_blocking (1 of 2 overloads)]
+[heading Remarks]
+
+This overload assumes that a default constructed object of type `Iterator` represents the end of the sequence. This is a valid assumption for iterator types such as `boost::asio::ip::tcp::resolver::iterator`.
-Gets the non-blocking mode of the socket.
+[heading Example]
+
+The following connect condition function object can be used to output information about the individual connection attempts:
+ struct my_connect_condition
+ {
+ template <typename Iterator>
+ Iterator operator()(
+ const boost::system::error_code& ec,
+ Iterator next)
+ {
+ if (ec) std::cout << "Error: " << ec.message() << std::endl;
+ std::cout << "Trying: " << next->endpoint() << std::endl;
+ return next;
+ }
+ };
- bool non_blocking(
- const implementation_type & impl) const;
+It would be used with the `boost::asio::connect` function as follows:
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::socket s(io_service);
+ boost::system::error_code ec;
+ tcp::resolver::iterator i = boost::asio::connect(
+ s, r.resolve(q), my_connect_condition(), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ std::cout << "Connected to: " << i->endpoint() << std::endl;
+ }
-[endsect]
-[section:overload2 datagram_socket_service::non_blocking (2 of 2 overloads)]
-Sets the non-blocking mode of the socket.
+[endsect]
- boost::system::error_code non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+[section:overload7 connect (7 of 8 overloads)]
-[endsect]
+Establishes a socket connection by trying each endpoint in a sequence.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ ConnectCondition connect_condition);
-[section:open datagram_socket_service::open]
-[indexterm2 open..datagram_socket_service]
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
- boost::system::error_code open(
- implementation_type & impl,
- const protocol_type & protocol,
- boost::system::error_code & ec);
+[heading Parameters]
+
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[endsect]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
+[[end][An iterator pointing to the end of a sequence of endpoints.]]
+[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
+``
+ Iterator connect_condition(
+ const boost::system::error_code& ec,
+ Iterator next);
+``
+The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
-[section:protocol_type datagram_socket_service::protocol_type]
+]
-[indexterm2 protocol_type..datagram_socket_service]
-The protocol type.
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
- typedef Protocol protocol_type;
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the sequence is empty, the associated `error_code` is `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/datagram_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Example]
+
+The following connect condition function object can be used to output information about the individual connection attempts:
+ struct my_connect_condition
+ {
+ template <typename Iterator>
+ Iterator operator()(
+ const boost::system::error_code& ec,
+ Iterator next)
+ {
+ if (ec) std::cout << "Error: " << ec.message() << std::endl;
+ std::cout << "Trying: " << next->endpoint() << std::endl;
+ return next;
+ }
+ };
-[endsect]
+It would be used with the `boost::asio::connect` function as follows:
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::resolver::iterator i = r.resolve(q), end;
+ tcp::socket s(io_service);
+ i = boost::asio::connect(s, i, end, my_connect_condition());
+ std::cout << "Connected to: " << i->endpoint() << std::endl;
-[section:receive datagram_socket_service::receive]
-[indexterm2 receive..datagram_socket_service]
-Receive some data from the peer.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
@@ -51264,375 +51053,298 @@
-[section:receive_from datagram_socket_service::receive_from]
+[section:overload8 connect (8 of 8 overloads)]
-[indexterm2 receive_from..datagram_socket_service]
-Receive a datagram with the endpoint of the sender.
+
+Establishes a socket connection by trying each endpoint in a sequence.
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive_from(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- endpoint_type & sender_endpoint,
- socket_base::message_flags flags,
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename Iterator,
+ typename ConnectCondition>
+ Iterator connect(
+ basic_socket< Protocol, SocketService > & s,
+ Iterator begin,
+ Iterator end,
+ ConnectCondition connect_condition,
boost::system::error_code & ec);
+This function attempts to connect a socket to one of a sequence of endpoints. It does this by repeated calls to the socket's `connect` member function, once for each endpoint in the sequence, until a connection is successfully established.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[s][The socket to be connected. If the socket is already open, it will be closed.]]
-[section:remote_endpoint datagram_socket_service::remote_endpoint]
+[[begin][An iterator pointing to the start of a sequence of endpoints.]]
-[indexterm2 remote_endpoint..datagram_socket_service]
-Get the remote endpoint.
+[[end][An iterator pointing to the end of a sequence of endpoints.]]
+[[connect_condition][A function object that is called prior to each connection attempt. The signature of the function object must be:
+``
+ Iterator connect_condition(
+ const boost::system::error_code& ec,
+ Iterator next);
+``
+The `ec` parameter contains the result from the most recent connect operation. Before the first connection attempt, `ec` is always set to indicate success. The `next` parameter is an iterator pointing to the next endpoint to be tried. The function object should return the next iterator, but is permitted to return a different iterator so that endpoints may be skipped. The implementation guarantees that the function object will never be called with the end iterator.]]
- endpoint_type remote_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+[[ec][Set to indicate what error occurred, if any. If the sequence is empty, set to `boost::asio::error::not_found`. Otherwise, contains the error from the last connection attempt.]]
+]
-[endsect]
-
-
-
-[section:send datagram_socket_service::send]
+[heading Return Value]
+
+On success, an iterator denoting the successfully connected endpoint. Otherwise, the end iterator.
-[indexterm2 send..datagram_socket_service]
-Send the given data to the peer.
+[heading Example]
+
+The following connect condition function object can be used to output information about the individual connection attempts:
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+ struct my_connect_condition
+ {
+ template <typename Iterator>
+ Iterator operator()(
+ const boost::system::error_code& ec,
+ Iterator next)
+ {
+ if (ec) std::cout << "Error: " << ec.message() << std::endl;
+ std::cout << "Trying: " << next->endpoint() << std::endl;
+ return next;
+ }
+ };
+It would be used with the `boost::asio::connect` function as follows:
-[endsect]
+ tcp::resolver r(io_service);
+ tcp::resolver::query q("host", "service");
+ tcp::resolver::iterator i = r.resolve(q), end;
+ tcp::socket s(io_service);
+ boost::system::error_code ec;
+ i = boost::asio::connect(s, i, end, my_connect_condition(), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ std::cout << "Connected to: " << i->endpoint() << std::endl;
+ }
-[section:send_to datagram_socket_service::send_to]
-[indexterm2 send_to..datagram_socket_service]
-Send a datagram to the specified endpoint.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send_to(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- const endpoint_type & destination,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+[endsect]
[endsect]
+[section:const_buffer const_buffer]
-[section:set_option datagram_socket_service::set_option]
-
-[indexterm2 set_option..datagram_socket_service]
-Set a socket option.
+Holds a buffer that cannot be modified.
- template<
- typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
- boost::system::error_code set_option(
- implementation_type & impl,
- const SettableSocketOption & option,
- boost::system::error_code & ec);
+ class const_buffer
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.const_buffer.const_buffer [*const_buffer]]]
+ [Construct an empty buffer.
+ Construct a buffer to represent a given memory range.
+ Construct a non-modifiable buffer from a modifiable one. ]
+ ]
+
+]
-[section:shutdown datagram_socket_service::shutdown]
+[heading Related Functions]
+[table
+ [[Name][Description]]
-[indexterm2 shutdown..datagram_socket_service]
-Disable sends or receives on the socket.
+ [
+ [[link boost_asio.reference.const_buffer.operator_plus_ [*operator+]]]
+ [Create a new non-modifiable buffer that is offset from the start of another. ]
+ ]
+
+]
+The [link boost_asio.reference.const_buffer `const_buffer`] class provides a safe representation of a buffer that cannot be modified. It does not own the underlying data, and so is cheap to copy or assign.
- boost::system::error_code shutdown(
- implementation_type & impl,
- socket_base::shutdown_type what,
- boost::system::error_code & ec);
+[heading Accessing Buffer Contents]
+
-[endsect]
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
-[endsect]
+ boost::asio::const_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
-[section:deadline_timer deadline_timer]
-[indexterm1 deadline_timer]
-Typedef for the typical usage of timer. Uses a UTC clock.
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
- typedef basic_deadline_timer< boost::posix_time::ptime > deadline_timer;
+[heading Requirements]
+[*Header: ][^boost/asio/buffer.hpp]
-[heading Types]
-[table
- [[Name][Description]]
+[*Convenience header: ][^boost/asio.hpp]
- [
+[section:const_buffer const_buffer::const_buffer]
- [[link boost_asio.reference.basic_deadline_timer.duration_type [*duration_type]]]
- [The duration type. ]
-
- ]
+[indexterm2 const_buffer..const_buffer]
+Construct an empty buffer.
- [
- [[link boost_asio.reference.basic_deadline_timer.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+ ``[link boost_asio.reference.const_buffer.const_buffer.overload1 const_buffer]``();
+ `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload1 more...]]``
- [
- [[link boost_asio.reference.basic_deadline_timer.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
+Construct a buffer to represent a given memory range.
- [
- [[link boost_asio.reference.basic_deadline_timer.time_type [*time_type]]]
- [The time type. ]
-
- ]
+ ``[link boost_asio.reference.const_buffer.const_buffer.overload2 const_buffer]``(
+ const void * data,
+ std::size_t size);
+ `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload2 more...]]``
- [
- [[link boost_asio.reference.basic_deadline_timer.traits_type [*traits_type]]]
- [The time traits type. ]
-
- ]
+Construct a non-modifiable buffer from a modifiable one.
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
+ ``[link boost_asio.reference.const_buffer.const_buffer.overload3 const_buffer]``(
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.const_buffer.const_buffer.overload3 more...]]``
- [
- [[link boost_asio.reference.basic_deadline_timer.async_wait [*async_wait]]]
- [Start an asynchronous wait on the timer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.basic_deadline_timer [*basic_deadline_timer]]]
- [Constructor.
- Constructor to set a particular expiry time as an absolute time.
+[section:overload1 const_buffer::const_buffer (1 of 3 overloads)]
- Constructor to set a particular expiry time relative to now. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.cancel [*cancel]]]
- [Cancel any asynchronous operations that are waiting on the timer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.cancel_one [*cancel_one]]]
- [Cancels one asynchronous operation that is waiting on the timer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.expires_at [*expires_at]]]
- [Get the timer's expiry time as an absolute time.
- Set the timer's expiry time as an absolute time. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.expires_from_now [*expires_from_now]]]
- [Get the timer's expiry time relative to now.
+Construct an empty buffer.
- Set the timer's expiry time relative to now. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.wait [*wait]]]
- [Perform a blocking wait on the timer. ]
- ]
-
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+ const_buffer();
- [
- [[link boost_asio.reference.basic_deadline_timer.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_deadline_timer.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_deadline_timer.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_deadline_timer.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-]
-The [link boost_asio.reference.basic_deadline_timer `basic_deadline_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
+[section:overload2 const_buffer::const_buffer (2 of 3 overloads)]
-A deadline timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
-Most applications will use the [link boost_asio.reference.deadline_timer `deadline_timer`] typedef.
+Construct a buffer to represent a given memory range.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+ const_buffer(
+ const void * data,
+ std::size_t size);
-[*Shared] [*objects:] Unsafe.
-[heading Examples]
-
-Performing a blocking wait:
+[endsect]
- // Construct a timer without setting an expiry time.
- boost::asio::deadline_timer timer(io_service);
- // Set an expiry time relative to now.
- timer.expires_from_now(boost::posix_time::seconds(5));
- // Wait for the timer to expire.
- timer.wait();
+[section:overload3 const_buffer::const_buffer (3 of 3 overloads)]
+Construct a non-modifiable buffer from a modifiable one.
+ const_buffer(
+ const mutable_buffer & b);
-Performing an asynchronous wait:
- void handler(const boost::system::error_code& error)
- {
- if (!error)
- {
- // Timer expired.
- }
- }
- ...
+[endsect]
- // Construct a timer with an absolute expiry time.
- boost::asio::deadline_timer timer(io_service,
- boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
- // Start an asynchronous wait.
- timer.async_wait(handler);
+[endsect]
+[section:operator_plus_ const_buffer::operator+]
+[indexterm2 operator+..const_buffer]
+Create a new non-modifiable buffer that is offset from the start of another.
+ const_buffer ``[link boost_asio.reference.const_buffer.operator_plus_.overload1 operator+]``(
+ const const_buffer & b,
+ std::size_t start);
+ `` [''''»''' [link boost_asio.reference.const_buffer.operator_plus_.overload1 more...]]``
-[heading Changing an active deadline_timer's expiry time]
-
+ const_buffer ``[link boost_asio.reference.const_buffer.operator_plus_.overload2 operator+]``(
+ std::size_t start,
+ const const_buffer & b);
+ `` [''''»''' [link boost_asio.reference.const_buffer.operator_plus_.overload2 more...]]``
-Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
+[section:overload1 const_buffer::operator+ (1 of 2 overloads)]
+Create a new non-modifiable buffer that is offset from the start of another.
- void on_some_event()
- {
- if (my_timer.expires_from_now(seconds(5)) > 0)
- {
- // We managed to cancel the timer. Start new asynchronous wait.
- my_timer.async_wait(on_timeout);
- }
- else
- {
- // Too late, timer has already expired!
- }
- }
- void on_timeout(const boost::system::error_code& e)
- {
- if (e != boost::asio::error::operation_aborted)
- {
- // Timer was not cancelled, take necessary action.
- }
- }
+ const_buffer operator+(
+ const const_buffer & b,
+ std::size_t start);
+[endsect]
-* The `boost::asio::basic_deadline_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
+[section:overload2 const_buffer::operator+ (2 of 2 overloads)]
-* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
+Create a new non-modifiable buffer that is offset from the start of another.
+ const_buffer operator+(
+ std::size_t start,
+ const const_buffer & b);
-[heading Requirements]
-[*Header: ][^boost/asio/deadline_timer.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
-[section:deadline_timer_service deadline_timer_service]
+[endsect]
+[section:const_buffers_1 const_buffers_1]
-Default service implementation for a timer.
+Adapts a single non-modifiable buffer so that it meets the requirements of the ConstBufferSequence concept.
- template<
- typename TimeType,
- typename ``[link boost_asio.reference.TimeTraits TimeTraits]`` = boost::asio::time_traits<TimeType>>
- class deadline_timer_service :
- public io_service::service
+
+ class const_buffers_1 :
+ public const_buffer
[heading Types]
@@ -51641,29 +51353,15 @@
[
- [[link boost_asio.reference.deadline_timer_service.duration_type [*duration_type]]]
- [The duration type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.deadline_timer_service.implementation_type [*implementation_type]]]
- [The implementation type of the deadline timer. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.deadline_timer_service.time_type [*time_type]]]
- [The time type. ]
+ [[link boost_asio.reference.const_buffers_1.const_iterator [*const_iterator]]]
+ [A random-access iterator type that may be used to read elements. ]
]
[
- [[link boost_asio.reference.deadline_timer_service.traits_type [*traits_type]]]
- [The time traits type. ]
+ [[link boost_asio.reference.const_buffers_1.value_type [*value_type]]]
+ [The type for each element in the list of buffers. ]
]
@@ -51674,120 +51372,84 @@
[[Name][Description]]
[
- [[link boost_asio.reference.deadline_timer_service.async_wait [*async_wait]]]
- []
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.cancel [*cancel]]]
- [Cancel any asynchronous wait operations associated with the timer. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.cancel_one [*cancel_one]]]
- [Cancels one asynchronous wait operation associated with the timer. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.construct [*construct]]]
- [Construct a new timer implementation. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.deadline_timer_service [*deadline_timer_service]]]
- [Construct a new timer service for the specified io_service. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.destroy [*destroy]]]
- [Destroy a timer implementation. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.expires_at [*expires_at]]]
- [Get the expiry time for the timer as an absolute time.
-
- Set the expiry time for the timer as an absolute time. ]
+ [[link boost_asio.reference.const_buffers_1.begin [*begin]]]
+ [Get a random-access iterator to the first element. ]
]
[
- [[link boost_asio.reference.deadline_timer_service.expires_from_now [*expires_from_now]]]
- [Get the expiry time for the timer relative to now.
+ [[link boost_asio.reference.const_buffers_1.const_buffers_1 [*const_buffers_1]]]
+ [Construct to represent a given memory range.
- Set the expiry time for the timer relative to now. ]
- ]
-
- [
- [[link boost_asio.reference.deadline_timer_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
+ Construct to represent a single non-modifiable buffer. ]
]
[
- [[link boost_asio.reference.deadline_timer_service.wait [*wait]]]
- []
+ [[link boost_asio.reference.const_buffers_1.end [*end]]]
+ [Get a random-access iterator for one past the last element. ]
]
]
-[heading Data Members]
+[heading Related Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.deadline_timer_service.id [*id]]]
- [The unique service identifier. ]
+ [[link boost_asio.reference.const_buffers_1.operator_plus_ [*operator+]]]
+ [Create a new non-modifiable buffer that is offset from the start of another. ]
]
-
+
]
[heading Requirements]
-[*Header: ][^boost/asio/deadline_timer_service.hpp]
+[*Header: ][^boost/asio/buffer.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:async_wait deadline_timer_service::async_wait]
+[section:begin const_buffers_1::begin]
-[indexterm2 async_wait..deadline_timer_service]
+[indexterm2 begin..const_buffers_1]
+Get a random-access iterator to the first element.
- template<
- typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
- void async_wait(
- implementation_type & impl,
- WaitHandler handler);
+
+ const_iterator begin() const;
[endsect]
+[section:const_buffers_1 const_buffers_1::const_buffers_1]
-[section:cancel deadline_timer_service::cancel]
+[indexterm2 const_buffers_1..const_buffers_1]
+Construct to represent a given memory range.
-[indexterm2 cancel..deadline_timer_service]
-Cancel any asynchronous wait operations associated with the timer.
+ ``[link boost_asio.reference.const_buffers_1.const_buffers_1.overload1 const_buffers_1]``(
+ const void * data,
+ std::size_t size);
+ `` [''''»''' [link boost_asio.reference.const_buffers_1.const_buffers_1.overload1 more...]]``
- std::size_t cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+Construct to represent a single non-modifiable buffer.
-[endsect]
+ explicit ``[link boost_asio.reference.const_buffers_1.const_buffers_1.overload2 const_buffers_1]``(
+ const const_buffer & b);
+ `` [''''»''' [link boost_asio.reference.const_buffers_1.const_buffers_1.overload2 more...]]``
+[section:overload1 const_buffers_1::const_buffers_1 (1 of 2 overloads)]
-[section:cancel_one deadline_timer_service::cancel_one]
-[indexterm2 cancel_one..deadline_timer_service]
-Cancels one asynchronous wait operation associated with the timer.
+Construct to represent a given memory range.
- std::size_t cancel_one(
- implementation_type & impl,
- boost::system::error_code & ec);
+ const_buffers_1(
+ const void * data,
+ std::size_t size);
@@ -51795,281 +51457,550 @@
-[section:construct deadline_timer_service::construct]
+[section:overload2 const_buffers_1::const_buffers_1 (2 of 2 overloads)]
-[indexterm2 construct..deadline_timer_service]
-Construct a new timer implementation.
+
+Construct to represent a single non-modifiable buffer.
- void construct(
- implementation_type & impl);
+ const_buffers_1(
+ const const_buffer & b);
[endsect]
+[endsect]
-[section:deadline_timer_service deadline_timer_service::deadline_timer_service]
-[indexterm2 deadline_timer_service..deadline_timer_service]
-Construct a new timer service for the specified [link boost_asio.reference.io_service `io_service`].
+[section:const_iterator const_buffers_1::const_iterator]
+[indexterm2 const_iterator..const_buffers_1]
+A random-access iterator type that may be used to read elements.
- deadline_timer_service(
- boost::asio::io_service & io_service);
+ typedef const const_buffer * const_iterator;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/buffer.hpp]
-[section:destroy deadline_timer_service::destroy]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 destroy..deadline_timer_service]
-Destroy a timer implementation.
+[endsect]
- void destroy(
- implementation_type & impl);
+[section:end const_buffers_1::end]
-[endsect]
+[indexterm2 end..const_buffers_1]
+Get a random-access iterator for one past the last element.
+ const_iterator end() const;
-[section:duration_type deadline_timer_service::duration_type]
-[indexterm2 duration_type..deadline_timer_service]
-The duration type.
+[endsect]
- typedef traits_type::duration_type duration_type;
+[section:operator_plus_ const_buffers_1::operator+]
+[indexterm2 operator+..const_buffers_1]
+Create a new non-modifiable buffer that is offset from the start of another.
-[heading Requirements]
-[*Header: ][^boost/asio/deadline_timer_service.hpp]
+ const_buffer ``[link boost_asio.reference.const_buffers_1.operator_plus_.overload1 operator+]``(
+ const const_buffer & b,
+ std::size_t start);
+ `` [''''»''' [link boost_asio.reference.const_buffers_1.operator_plus_.overload1 more...]]``
-[*Convenience header: ][^boost/asio.hpp]
+ const_buffer ``[link boost_asio.reference.const_buffers_1.operator_plus_.overload2 operator+]``(
+ std::size_t start,
+ const const_buffer & b);
+ `` [''''»''' [link boost_asio.reference.const_buffers_1.operator_plus_.overload2 more...]]``
-[endsect]
+[section:overload1 const_buffers_1::operator+ (1 of 2 overloads)]
-[section:expires_at deadline_timer_service::expires_at]
+['Inherited from const_buffer.]
-[indexterm2 expires_at..deadline_timer_service]
-Get the expiry time for the timer as an absolute time.
+Create a new non-modifiable buffer that is offset from the start of another.
- time_type ``[link boost_asio.reference.deadline_timer_service.expires_at.overload1 expires_at]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_at.overload1 more...]]``
+ const_buffer operator+(
+ const const_buffer & b,
+ std::size_t start);
-Set the expiry time for the timer as an absolute time.
- std::size_t ``[link boost_asio.reference.deadline_timer_service.expires_at.overload2 expires_at]``(
- implementation_type & impl,
- const time_type & expiry_time,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_at.overload2 more...]]``
+[endsect]
-[section:overload1 deadline_timer_service::expires_at (1 of 2 overloads)]
+[section:overload2 const_buffers_1::operator+ (2 of 2 overloads)]
-Get the expiry time for the timer as an absolute time.
+['Inherited from const_buffer.]
- time_type expires_at(
- const implementation_type & impl) const;
+
+Create a new non-modifiable buffer that is offset from the start of another.
+
+
+ const_buffer operator+(
+ std::size_t start,
+ const const_buffer & b);
[endsect]
+[endsect]
-[section:overload2 deadline_timer_service::expires_at (2 of 2 overloads)]
+[section:value_type const_buffers_1::value_type]
-Set the expiry time for the timer as an absolute time.
+[indexterm2 value_type..const_buffers_1]
+The type for each element in the list of buffers.
- std::size_t expires_at(
- implementation_type & impl,
- const time_type & expiry_time,
- boost::system::error_code & ec);
+ typedef const_buffer value_type;
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.const_buffer.const_buffer [*const_buffer]]]
+ [Construct an empty buffer.
+ Construct a buffer to represent a given memory range.
-[endsect]
+ Construct a non-modifiable buffer from a modifiable one. ]
+ ]
+
+]
-[section:expires_from_now deadline_timer_service::expires_from_now]
+[heading Related Functions]
+[table
+ [[Name][Description]]
-[indexterm2 expires_from_now..deadline_timer_service]
-Get the expiry time for the timer relative to now.
+ [
+ [[link boost_asio.reference.const_buffer.operator_plus_ [*operator+]]]
+ [Create a new non-modifiable buffer that is offset from the start of another. ]
+ ]
+
+]
+The [link boost_asio.reference.const_buffer `const_buffer`] class provides a safe representation of a buffer that cannot be modified. It does not own the underlying data, and so is cheap to copy or assign.
- duration_type ``[link boost_asio.reference.deadline_timer_service.expires_from_now.overload1 expires_from_now]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_from_now.overload1 more...]]``
+[heading Accessing Buffer Contents]
+
-Set the expiry time for the timer relative to now.
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
- std::size_t ``[link boost_asio.reference.deadline_timer_service.expires_from_now.overload2 expires_from_now]``(
- implementation_type & impl,
- const duration_type & expiry_time,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_from_now.overload2 more...]]``
-[section:overload1 deadline_timer_service::expires_from_now (1 of 2 overloads)]
+ boost::asio::const_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
-Get the expiry time for the timer relative to now.
- duration_type expires_from_now(
- const implementation_type & impl) const;
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 deadline_timer_service::expires_from_now (2 of 2 overloads)]
+[endsect]
+[section:datagram_socket_service datagram_socket_service]
-Set the expiry time for the timer relative to now.
+Default service implementation for a datagram socket.
- std::size_t expires_from_now(
- implementation_type & impl,
- const duration_type & expiry_time,
- boost::system::error_code & ec);
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class datagram_socket_service :
+ public io_service::service
-[endsect]
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[endsect]
+ [[link boost_asio.reference.datagram_socket_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+ [
-[section:get_io_service deadline_timer_service::get_io_service]
+ [[link boost_asio.reference.datagram_socket_service.implementation_type [*implementation_type]]]
+ [The type of a datagram socket. ]
+
+ ]
+ [
-['Inherited from io_service.]
+ [[link boost_asio.reference.datagram_socket_service.native_handle_type [*native_handle_type]]]
+ [The native socket type. ]
+
+ ]
-[indexterm2 get_io_service..deadline_timer_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ [
+
+ [[link boost_asio.reference.datagram_socket_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native socket type. ]
+
+ ]
+ [
- boost::asio::io_service & get_io_service();
+ [[link boost_asio.reference.datagram_socket_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.datagram_socket_service.assign [*assign]]]
+ [Assign an existing native socket to a datagram socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.async_receive_from [*async_receive_from]]]
+ [Start an asynchronous receive that will get the endpoint of the sender. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.async_send [*async_send]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.async_send_to [*async_send_to]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.bind [*bind]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.close [*close]]]
+ [Close a datagram socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.connect [*connect]]]
+ [Connect the datagram socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.construct [*construct]]]
+ [Construct a new datagram socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.datagram_socket_service [*datagram_socket_service]]]
+ [Construct a new datagram socket service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.destroy [*destroy]]]
+ [Destroy a datagram socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.get_option [*get_option]]]
+ [Get a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.move_assign [*move_assign]]]
+ [Move-assign from another datagram socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.move_construct [*move_construct]]]
+ [Move-construct a new datagram socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.native_handle [*native_handle]]]
+ [Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.open [*open]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.receive [*receive]]]
+ [Receive some data from the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.receive_from [*receive_from]]]
+ [Receive a datagram with the endpoint of the sender. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.send [*send]]]
+ [Send the given data to the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.send_to [*send_to]]]
+ [Send a datagram to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.set_option [*set_option]]]
+ [Set a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.datagram_socket_service.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+]
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.datagram_socket_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
-[section:id deadline_timer_service::id]
+]
-[indexterm2 id..deadline_timer_service]
-The unique service identifier.
+[heading Requirements]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
- static boost::asio::io_service::id id;
+[*Convenience header: ][^boost/asio.hpp]
+[section:assign datagram_socket_service::assign]
-[endsect]
+[indexterm2 assign..datagram_socket_service]
+Assign an existing native socket to a datagram socket.
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ const native_handle_type & native_socket,
+ boost::system::error_code & ec);
-[section:implementation_type deadline_timer_service::implementation_type]
-[indexterm2 implementation_type..deadline_timer_service]
-The implementation type of the deadline timer.
+[endsect]
- typedef implementation_defined implementation_type;
+[section:async_connect datagram_socket_service::async_connect]
-[heading Requirements]
+[indexterm2 async_connect..datagram_socket_service]
+Start an asynchronous connect.
-[*Header: ][^boost/asio/deadline_timer_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ template<
+ typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
+ void async_connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ ConnectHandler handler);
+
[endsect]
-[section:time_type deadline_timer_service::time_type]
+[section:async_receive datagram_socket_service::async_receive]
-[indexterm2 time_type..deadline_timer_service]
-The time type.
+[indexterm2 async_receive..datagram_socket_service]
+Start an asynchronous receive.
- typedef traits_type::time_type time_type;
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ ReadHandler handler);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/deadline_timer_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:async_receive_from datagram_socket_service::async_receive_from]
-[endsect]
+[indexterm2 async_receive_from..datagram_socket_service]
+Start an asynchronous receive that will get the endpoint of the sender.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive_from(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ endpoint_type & sender_endpoint,
+ socket_base::message_flags flags,
+ ReadHandler handler);
-[section:traits_type deadline_timer_service::traits_type]
-[indexterm2 traits_type..deadline_timer_service]
-The time traits type.
+[endsect]
- typedef TimeTraits traits_type;
+[section:async_send datagram_socket_service::async_send]
-[heading Requirements]
+[indexterm2 async_send..datagram_socket_service]
+Start an asynchronous send.
-[*Header: ][^boost/asio/deadline_timer_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ WriteHandler handler);
+
[endsect]
-[section:wait deadline_timer_service::wait]
+[section:async_send_to datagram_socket_service::async_send_to]
-[indexterm2 wait..deadline_timer_service]
+[indexterm2 async_send_to..datagram_socket_service]
+Start an asynchronous send.
- void wait(
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send_to(
implementation_type & impl,
- boost::system::error_code & ec);
+ const ConstBufferSequence & buffers,
+ const endpoint_type & destination,
+ socket_base::message_flags flags,
+ WriteHandler handler);
@@ -52077,295 +52008,160 @@
-[endsect]
+[section:at_mark datagram_socket_service::at_mark]
+
+[indexterm2 at_mark..datagram_socket_service]
+Determine whether the socket is at the out-of-band data mark.
-[section:error__addrinfo_category error::addrinfo_category]
+ bool at_mark(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[indexterm1 error::addrinfo_category]
- static const boost::system::error_category & addrinfo_category = boost::asio::error::get_addrinfo_category();
+
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[section:available datagram_socket_service::available]
+
+[indexterm2 available..datagram_socket_service]
+Determine the number of bytes available for reading.
+
+
+ std::size_t available(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:error__addrinfo_errors error::addrinfo_errors]
+[section:bind datagram_socket_service::bind]
-[indexterm1 error::addrinfo_errors]
+[indexterm2 bind..datagram_socket_service]
- enum addrinfo_errors
+ boost::system::error_code bind(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
-[indexterm2 service_not_found..error::addrinfo_errors]
-[indexterm2 socket_type_not_supported..error::addrinfo_errors]
-[heading Values]
-[variablelist
- [
- [service_not_found]
- [The service is not supported for the given socket type. ]
- ]
+[endsect]
- [
- [socket_type_not_supported]
- [The socket type is not supported. ]
- ]
-]
+[section:cancel datagram_socket_service::cancel]
-[heading Requirements]
+[indexterm2 cancel..datagram_socket_service]
+Cancel all asynchronous operations associated with the socket.
-[*Header: ][^boost/asio/error.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
[endsect]
-[section:error__basic_errors error::basic_errors]
+[section:close datagram_socket_service::close]
-[indexterm1 error::basic_errors]
+[indexterm2 close..datagram_socket_service]
+Close a datagram socket implementation.
- enum basic_errors
-[indexterm2 access_denied..error::basic_errors]
-[indexterm2 address_family_not_supported..error::basic_errors]
-[indexterm2 address_in_use..error::basic_errors]
-[indexterm2 already_connected..error::basic_errors]
-[indexterm2 already_started..error::basic_errors]
-[indexterm2 broken_pipe..error::basic_errors]
-[indexterm2 connection_aborted..error::basic_errors]
-[indexterm2 connection_refused..error::basic_errors]
-[indexterm2 connection_reset..error::basic_errors]
-[indexterm2 bad_descriptor..error::basic_errors]
-[indexterm2 fault..error::basic_errors]
-[indexterm2 host_unreachable..error::basic_errors]
-[indexterm2 in_progress..error::basic_errors]
-[indexterm2 interrupted..error::basic_errors]
-[indexterm2 invalid_argument..error::basic_errors]
-[indexterm2 message_size..error::basic_errors]
-[indexterm2 name_too_long..error::basic_errors]
-[indexterm2 network_down..error::basic_errors]
-[indexterm2 network_reset..error::basic_errors]
-[indexterm2 network_unreachable..error::basic_errors]
-[indexterm2 no_descriptors..error::basic_errors]
-[indexterm2 no_buffer_space..error::basic_errors]
-[indexterm2 no_memory..error::basic_errors]
-[indexterm2 no_permission..error::basic_errors]
-[indexterm2 no_protocol_option..error::basic_errors]
-[indexterm2 not_connected..error::basic_errors]
-[indexterm2 not_socket..error::basic_errors]
-[indexterm2 operation_aborted..error::basic_errors]
-[indexterm2 operation_not_supported..error::basic_errors]
-[indexterm2 shut_down..error::basic_errors]
-[indexterm2 timed_out..error::basic_errors]
-[indexterm2 try_again..error::basic_errors]
-[indexterm2 would_block..error::basic_errors]
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[heading Values]
-[variablelist
- [
- [access_denied]
- [Permission denied. ]
- ]
- [
- [address_family_not_supported]
- [Address family not supported by protocol. ]
- ]
+[endsect]
- [
- [address_in_use]
- [Address already in use. ]
- ]
- [
- [already_connected]
- [Transport endpoint is already connected. ]
- ]
- [
- [already_started]
- [Operation already in progress. ]
- ]
+[section:connect datagram_socket_service::connect]
- [
- [broken_pipe]
- [Broken pipe. ]
- ]
+[indexterm2 connect..datagram_socket_service]
+Connect the datagram socket to the specified endpoint.
- [
- [connection_aborted]
- [A connection has been aborted. ]
- ]
- [
- [connection_refused]
- [Connection refused. ]
- ]
+ boost::system::error_code connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ boost::system::error_code & ec);
- [
- [connection_reset]
- [Connection reset by peer. ]
- ]
- [
- [bad_descriptor]
- [Bad file descriptor. ]
- ]
- [
- [fault]
- [Bad address. ]
- ]
+[endsect]
- [
- [host_unreachable]
- [No route to host. ]
- ]
- [
- [in_progress]
- [Operation now in progress. ]
- ]
- [
- [interrupted]
- [Interrupted system call. ]
- ]
+[section:construct datagram_socket_service::construct]
- [
- [invalid_argument]
- [Invalid argument. ]
- ]
+[indexterm2 construct..datagram_socket_service]
+Construct a new datagram socket implementation.
- [
- [message_size]
- [Message too long. ]
- ]
- [
- [name_too_long]
- [The name was too long. ]
- ]
+ void construct(
+ implementation_type & impl);
- [
- [network_down]
- [Network is down. ]
- ]
- [
- [network_reset]
- [Network dropped connection on reset. ]
- ]
- [
- [network_unreachable]
- [Network is unreachable. ]
- ]
+[endsect]
- [
- [no_descriptors]
- [Too many open files. ]
- ]
- [
- [no_buffer_space]
- [No buffer space available. ]
- ]
- [
- [no_memory]
- [Cannot allocate memory. ]
- ]
+[section:datagram_socket_service datagram_socket_service::datagram_socket_service]
- [
- [no_permission]
- [Operation not permitted. ]
- ]
+[indexterm2 datagram_socket_service..datagram_socket_service]
+Construct a new datagram socket service for the specified [link boost_asio.reference.io_service `io_service`].
- [
- [no_protocol_option]
- [Protocol not available. ]
- ]
- [
- [not_connected]
- [Transport endpoint is not connected. ]
- ]
+ datagram_socket_service(
+ boost::asio::io_service & io_service);
- [
- [not_socket]
- [Socket operation on non-socket. ]
- ]
- [
- [operation_aborted]
- [Operation cancelled. ]
- ]
- [
- [operation_not_supported]
- [Operation not supported. ]
- ]
+[endsect]
- [
- [shut_down]
- [Cannot send after transport endpoint shutdown. ]
- ]
- [
- [timed_out]
- [Connection timed out. ]
- ]
- [
- [try_again]
- [Resource temporarily unavailable. ]
- ]
+[section:destroy datagram_socket_service::destroy]
- [
- [would_block]
- [The socket is marked non-blocking and the requested operation would block. ]
- ]
+[indexterm2 destroy..datagram_socket_service]
+Destroy a datagram socket implementation.
-]
+ void destroy(
+ implementation_type & impl);
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[endsect]
+[section:endpoint_type datagram_socket_service::endpoint_type]
+[indexterm2 endpoint_type..datagram_socket_service]
+The endpoint type.
-[section:error__get_addrinfo_category error::get_addrinfo_category]
-[indexterm1 error::get_addrinfo_category]
+ typedef Protocol::endpoint endpoint_type;
- const boost::system::error_category & get_addrinfo_category();
[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -52374,70 +52170,69 @@
-[section:error__get_misc_category error::get_misc_category]
+[section:get_io_service datagram_socket_service::get_io_service]
-[indexterm1 error::get_misc_category]
- const boost::system::error_category & get_misc_category();
+['Inherited from io_service.]
+[indexterm2 get_io_service..datagram_socket_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+ boost::asio::io_service & get_io_service();
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:error__get_netdb_category error::get_netdb_category]
-
-[indexterm1 error::get_netdb_category]
-
- const boost::system::error_category & get_netdb_category();
+[section:get_option datagram_socket_service::get_option]
+[indexterm2 get_option..datagram_socket_service]
+Get a socket option.
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+ template<
+ typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSocketOption & option,
+ boost::system::error_code & ec) const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:error__get_ssl_category error::get_ssl_category]
+[section:id datagram_socket_service::id]
-[indexterm1 error::get_ssl_category]
+[indexterm2 id..datagram_socket_service]
+The unique service identifier.
- const boost::system::error_category & get_ssl_category();
+ static boost::asio::io_service::id id;
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/error.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[endsect]
-[endsect]
+[section:implementation_type datagram_socket_service::implementation_type]
+[indexterm2 implementation_type..datagram_socket_service]
+The type of a datagram socket.
-[section:error__get_system_category error::get_system_category]
-[indexterm1 error::get_system_category]
+ typedef implementation_defined implementation_type;
- const boost::system::error_category & get_system_category();
[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -52445,43 +52240,34 @@
[endsect]
-[section:error__make_error_code error::make_error_code]
-[indexterm1 error::make_error_code]
-
- boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload1 make_error_code]``(
- basic_errors e);
- `` [''''»''' [link boost_asio.reference.error__make_error_code.overload1 more...]]``
+[section:io_control datagram_socket_service::io_control]
- boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload2 make_error_code]``(
- netdb_errors e);
- `` [''''»''' [link boost_asio.reference.error__make_error_code.overload2 more...]]``
+[indexterm2 io_control..datagram_socket_service]
+Perform an IO control command on the socket.
- boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload3 make_error_code]``(
- addrinfo_errors e);
- `` [''''»''' [link boost_asio.reference.error__make_error_code.overload3 more...]]``
- boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload4 make_error_code]``(
- misc_errors e);
- `` [''''»''' [link boost_asio.reference.error__make_error_code.overload4 more...]]``
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
+ boost::system::error_code & ec);
- boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload5 make_error_code]``(
- ssl_errors e);
- `` [''''»''' [link boost_asio.reference.error__make_error_code.overload5 more...]]``
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
-[section:overload1 error::make_error_code (1 of 5 overloads)]
+[section:is_open datagram_socket_service::is_open]
+[indexterm2 is_open..datagram_socket_service]
+Determine whether the socket is open.
- boost::system::error_code make_error_code(
- basic_errors e);
+ bool is_open(
+ const implementation_type & impl) const;
@@ -52489,12 +52275,15 @@
-[section:overload2 error::make_error_code (2 of 5 overloads)]
+[section:local_endpoint datagram_socket_service::local_endpoint]
+[indexterm2 local_endpoint..datagram_socket_service]
+Get the local endpoint.
- boost::system::error_code make_error_code(
- netdb_errors e);
+ endpoint_type local_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
@@ -52502,12 +52291,16 @@
-[section:overload3 error::make_error_code (3 of 5 overloads)]
+[section:move_assign datagram_socket_service::move_assign]
+[indexterm2 move_assign..datagram_socket_service]
+Move-assign from another datagram socket implementation.
- boost::system::error_code make_error_code(
- addrinfo_errors e);
+ void move_assign(
+ implementation_type & impl,
+ datagram_socket_service & other_service,
+ implementation_type & other_impl);
@@ -52515,12 +52308,15 @@
-[section:overload4 error::make_error_code (4 of 5 overloads)]
+[section:move_construct datagram_socket_service::move_construct]
+[indexterm2 move_construct..datagram_socket_service]
+Move-construct a new datagram socket implementation.
- boost::system::error_code make_error_code(
- misc_errors e);
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
@@ -52528,31 +52324,49 @@
-[section:overload5 error::make_error_code (5 of 5 overloads)]
+[section:native datagram_socket_service::native]
+[indexterm2 native..datagram_socket_service]
+(Deprecated: Use `native_handle()`.) Get the native socket implementation.
- boost::system::error_code make_error_code(
- ssl_errors e);
+ native_type native(
+ implementation_type & impl);
[endsect]
+
+[section:native_handle datagram_socket_service::native_handle]
+
+[indexterm2 native_handle..datagram_socket_service]
+Get the native socket implementation.
+
+
+ native_handle_type native_handle(
+ implementation_type & impl);
+
+
+
[endsect]
-[section:error__misc_category error::misc_category]
-[indexterm1 error::misc_category]
+[section:native_handle_type datagram_socket_service::native_handle_type]
+
+[indexterm2 native_handle_type..datagram_socket_service]
+The native socket type.
+
+
+ typedef implementation_defined native_handle_type;
- static const boost::system::error_category & misc_category = boost::asio::error::get_misc_category();
[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -52560,65 +52374,74 @@
[endsect]
+[section:native_non_blocking datagram_socket_service::native_non_blocking]
-[section:error__misc_errors error::misc_errors]
+[indexterm2 native_non_blocking..datagram_socket_service]
+Gets the non-blocking mode of the native socket implementation.
-[indexterm1 error::misc_errors]
- enum misc_errors
+ bool ``[link boost_asio.reference.datagram_socket_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.datagram_socket_service.native_non_blocking.overload1 more...]]``
-[indexterm2 already_open..error::misc_errors]
-[indexterm2 eof..error::misc_errors]
-[indexterm2 not_found..error::misc_errors]
-[indexterm2 fd_set_failure..error::misc_errors]
-[heading Values]
-[variablelist
+Sets the non-blocking mode of the native socket implementation.
- [
- [already_open]
- [Already open. ]
- ]
- [
- [eof]
- [End of file or stream. ]
- ]
+ boost::system::error_code ``[link boost_asio.reference.datagram_socket_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.datagram_socket_service.native_non_blocking.overload2 more...]]``
- [
- [not_found]
- [Element not found. ]
- ]
- [
- [fd_set_failure]
- [The descriptor cannot fit into the select system call's fd_set. ]
- ]
+[section:overload1 datagram_socket_service::native_non_blocking (1 of 2 overloads)]
-]
+Gets the non-blocking mode of the native socket implementation.
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+ bool native_non_blocking(
+ const implementation_type & impl) const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:error__netdb_category error::netdb_category]
+[section:overload2 datagram_socket_service::native_non_blocking (2 of 2 overloads)]
-[indexterm1 error::netdb_category]
- static const boost::system::error_category & netdb_category = boost::asio::error::get_netdb_category();
+Sets the non-blocking mode of the native socket implementation.
+
+
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:native_type datagram_socket_service::native_type]
+
+[indexterm2 native_type..datagram_socket_service]
+(Deprecated: Use native\_handle\_type.) The native socket type.
+
+
+ typedef implementation_defined native_type;
+
[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -52626,101 +52449,89 @@
[endsect]
+[section:non_blocking datagram_socket_service::non_blocking]
-[section:error__netdb_errors error::netdb_errors]
+[indexterm2 non_blocking..datagram_socket_service]
+Gets the non-blocking mode of the socket.
-[indexterm1 error::netdb_errors]
- enum netdb_errors
+ bool ``[link boost_asio.reference.datagram_socket_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.datagram_socket_service.non_blocking.overload1 more...]]``
-[indexterm2 host_not_found..error::netdb_errors]
-[indexterm2 host_not_found_try_again..error::netdb_errors]
-[indexterm2 no_data..error::netdb_errors]
-[indexterm2 no_recovery..error::netdb_errors]
-[heading Values]
-[variablelist
+Sets the non-blocking mode of the socket.
- [
- [host_not_found]
- [Host not found (authoritative). ]
- ]
- [
- [host_not_found_try_again]
- [Host not found (non-authoritative). ]
- ]
+ boost::system::error_code ``[link boost_asio.reference.datagram_socket_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.datagram_socket_service.non_blocking.overload2 more...]]``
- [
- [no_data]
- [The query is valid but does not have associated address data. ]
- ]
- [
- [no_recovery]
- [A non-recoverable error occurred. ]
- ]
+[section:overload1 datagram_socket_service::non_blocking (1 of 2 overloads)]
-]
+Gets the non-blocking mode of the socket.
-[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+ bool non_blocking(
+ const implementation_type & impl) const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:error__ssl_category error::ssl_category]
-
-[indexterm1 error::ssl_category]
+[section:overload2 datagram_socket_service::non_blocking (2 of 2 overloads)]
- static const boost::system::error_category & ssl_category = boost::asio::error::get_ssl_category();
+Sets the non-blocking mode of the socket.
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/error.hpp]
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
-[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
+[endsect]
-[section:error__ssl_errors error::ssl_errors]
-[indexterm1 error::ssl_errors]
+[section:open datagram_socket_service::open]
- enum ssl_errors
+[indexterm2 open..datagram_socket_service]
+ boost::system::error_code open(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ boost::system::error_code & ec);
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/error.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[endsect]
-[endsect]
+[section:protocol_type datagram_socket_service::protocol_type]
+[indexterm2 protocol_type..datagram_socket_service]
+The protocol type.
-[section:error__system_category error::system_category]
-[indexterm1 error::system_category]
+ typedef Protocol protocol_type;
- static const boost::system::error_category & system_category = boost::asio::error::get_system_category();
[heading Requirements]
-[*Header: ][^boost/asio/error.hpp]
+[*Header: ][^boost/asio/datagram_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -52729,77 +52540,116 @@
-[section:has_service has_service]
+[section:receive datagram_socket_service::receive]
+
+[indexterm2 receive..datagram_socket_service]
+Receive some data from the peer.
-[indexterm1 has_service]
template<
- typename ``[link boost_asio.reference.Service Service]``>
- bool has_service(
- io_service & ios);
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-This function is used to determine whether the [link boost_asio.reference.io_service `io_service`] contains a service object corresponding to the given service type.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
-]
+[section:receive_from datagram_socket_service::receive_from]
+[indexterm2 receive_from..datagram_socket_service]
+Receive a datagram with the endpoint of the sender.
-[heading Return Value]
-
-A boolean indicating whether the [link boost_asio.reference.io_service `io_service`] contains the service.
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive_from(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ endpoint_type & sender_endpoint,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/io_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+
+[section:remote_endpoint datagram_socket_service::remote_endpoint]
+
+[indexterm2 remote_endpoint..datagram_socket_service]
+Get the remote endpoint.
+
+
+ endpoint_type remote_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
+
[endsect]
-[section:invalid_service_owner invalid_service_owner]
+[section:send datagram_socket_service::send]
-Exception thrown when trying to add a service object to an [link boost_asio.reference.io_service `io_service`] where the service has a different owner.
+[indexterm2 send..datagram_socket_service]
+Send the given data to the peer.
- class invalid_service_owner
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.invalid_service_owner.invalid_service_owner [*invalid_service_owner]]]
- []
- ]
-
-]
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:send_to datagram_socket_service::send_to]
+[indexterm2 send_to..datagram_socket_service]
+Send a datagram to the specified endpoint.
-[section:invalid_service_owner invalid_service_owner::invalid_service_owner]
-[indexterm2 invalid_service_owner..invalid_service_owner]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send_to(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ const endpoint_type & destination,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
- invalid_service_owner();
+
+
+[endsect]
+
+
+
+[section:set_option datagram_socket_service::set_option]
+
+[indexterm2 set_option..datagram_socket_service]
+Set a socket option.
+
+
+ template<
+ typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSocketOption & option,
+ boost::system::error_code & ec);
@@ -52807,16 +52657,33 @@
+[section:shutdown datagram_socket_service::shutdown]
+
+[indexterm2 shutdown..datagram_socket_service]
+Disable sends or receives on the socket.
+
+
+ boost::system::error_code shutdown(
+ implementation_type & impl,
+ socket_base::shutdown_type what,
+ boost::system::error_code & ec);
+
+
+
[endsect]
-[section:io_service io_service]
-Provides core I/O functionality.
+[endsect]
- class io_service :
- noncopyable
+[section:deadline_timer deadline_timer]
+
+[indexterm1 deadline_timer]
+Typedef for the typical usage of timer. Uses a UTC clock.
+
+
+ typedef basic_deadline_timer< boost::posix_time::ptime > deadline_timer;
[heading Types]
@@ -52825,36 +52692,36 @@
[
- [[link boost_asio.reference.io_service__id [*id]]]
- [Class used to uniquely identify a service. ]
+ [[link boost_asio.reference.basic_deadline_timer.duration_type [*duration_type]]]
+ [The duration type. ]
]
[
- [[link boost_asio.reference.io_service__service [*service]]]
- [Base class for all io_service services. ]
+ [[link boost_asio.reference.basic_deadline_timer.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.io_service__strand [*strand]]]
- [Provides serialised handler execution. ]
+ [[link boost_asio.reference.basic_deadline_timer.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
]
[
- [[link boost_asio.reference.io_service__work [*work]]]
- [Class to inform the io_service when it has work to do. ]
+ [[link boost_asio.reference.basic_deadline_timer.time_type [*time_type]]]
+ [The time type. ]
]
[
- [[link boost_asio.reference.io_service.fork_event [*fork_event]]]
- [Fork-related event notifications. ]
+ [[link boost_asio.reference.basic_deadline_timer.traits_type [*traits_type]]]
+ [The time traits type. ]
]
@@ -52865,344 +52732,373 @@
[[Name][Description]]
[
- [[link boost_asio.reference.io_service.dispatch [*dispatch]]]
- [Request the io_service to invoke the given handler. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.io_service [*io_service]]]
- [Constructor. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.notify_fork [*notify_fork]]]
- [Notify the io_service of a fork-related event. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.poll [*poll]]]
- [Run the io_service object's event processing loop to execute ready handlers. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.poll_one [*poll_one]]]
- [Run the io_service object's event processing loop to execute one ready handler. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.post [*post]]]
- [Request the io_service to invoke the given handler and return immediately. ]
+ [[link boost_asio.reference.basic_deadline_timer.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the timer. ]
]
[
- [[link boost_asio.reference.io_service.reset [*reset]]]
- [Reset the io_service in preparation for a subsequent run() invocation. ]
+ [[link boost_asio.reference.basic_deadline_timer.basic_deadline_timer [*basic_deadline_timer]]]
+ [Constructor.
+
+ Constructor to set a particular expiry time as an absolute time.
+
+ Constructor to set a particular expiry time relative to now. ]
]
[
- [[link boost_asio.reference.io_service.run [*run]]]
- [Run the io_service object's event processing loop. ]
+ [[link boost_asio.reference.basic_deadline_timer.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the timer. ]
]
[
- [[link boost_asio.reference.io_service.run_one [*run_one]]]
- [Run the io_service object's event processing loop to execute at most one handler. ]
+ [[link boost_asio.reference.basic_deadline_timer.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous operation that is waiting on the timer. ]
]
[
- [[link boost_asio.reference.io_service.stop [*stop]]]
- [Stop the io_service object's event processing loop. ]
+ [[link boost_asio.reference.basic_deadline_timer.expires_at [*expires_at]]]
+ [Get the timer's expiry time as an absolute time.
+
+ Set the timer's expiry time as an absolute time. ]
]
[
- [[link boost_asio.reference.io_service.stopped [*stopped]]]
- [Determine whether the io_service object has been stopped. ]
+ [[link boost_asio.reference.basic_deadline_timer.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
+
+ Set the timer's expiry time relative to now. ]
]
[
- [[link boost_asio.reference.io_service.wrap [*wrap]]]
- [Create a new handler that automatically dispatches the wrapped handler on the io_service. ]
+ [[link boost_asio.reference.basic_deadline_timer.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.io_service._io_service [*~io_service]]]
- [Destructor. ]
+ [[link boost_asio.reference.basic_deadline_timer.wait [*wait]]]
+ [Perform a blocking wait on the timer. ]
]
]
-[heading Friends]
+[heading Protected Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.io_service.add_service [*add_service]]]
- [Add a service object to the io_service. ]
- ]
-
- [
- [[link boost_asio.reference.io_service.has_service [*has_service]]]
- [Determine if an io_service contains a specified service type. ]
+ [[link boost_asio.reference.basic_deadline_timer.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.io_service.use_service [*use_service]]]
- [Obtain the service object corresponding to the given type. ]
+ [[link boost_asio.reference.basic_deadline_timer.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
]
]
-The [link boost_asio.reference.io_service `io_service`] class provides the core I/O functionality for users of the asynchronous I/O objects, including:
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_deadline_timer.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-* `boost::asio::ip::tcp::socket`
+ [
+ [[link boost_asio.reference.basic_deadline_timer.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
-* `boost::asio::ip::tcp::acceptor`
+]
-* `boost::asio::ip::udp::socket`
+The [link boost_asio.reference.basic_deadline_timer `basic_deadline_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
-* [link boost_asio.reference.deadline_timer `deadline_timer`].
+A deadline timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
-The [link boost_asio.reference.io_service `io_service`] class also includes facilities intended for developers of custom asynchronous services.
+Most applications will use the [link boost_asio.reference.deadline_timer `deadline_timer`] typedef.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Safe, with the specific exceptions of the `reset()` and `notify_fork()` functions. Calling `reset()` while there are unfinished `run()`, `run_one()`, `poll()` or `poll_one()` calls results in undefined behaviour. The `notify_fork()` function should not be called while any [link boost_asio.reference.io_service `io_service`] function, or any function on an I/O object that is associated with the [link boost_asio.reference.io_service `io_service`], is being called in another thread.
-
+[*Shared] [*objects:] Unsafe.
-[heading Synchronous and asynchronous operations]
+[heading Examples]
+Performing a blocking wait:
+ // Construct a timer without setting an expiry time.
+ boost::asio::deadline_timer timer(io_service);
-Synchronous operations on I/O objects implicitly run the [link boost_asio.reference.io_service `io_service`] object for an individual operation. The [link boost_asio.reference.io_service `io_service`] functions `run()`, `run_one()`, `poll()` or `poll_one()` must be called for the [link boost_asio.reference.io_service `io_service`] to perform asynchronous operations on behalf of a C++ program. Notification that an asynchronous operation has completed is delivered by invocation of the associated handler. Handlers are invoked only by a thread that is currently calling any overload of `run()`, `run_one()`, `poll()` or `poll_one()` for the [link boost_asio.reference.io_service `io_service`].
-
-
-[heading Effect of exceptions thrown from handlers]
-
+ // Set an expiry time relative to now.
+ timer.expires_from_now(boost::posix_time::seconds(5));
+ // Wait for the timer to expire.
+ timer.wait();
-If an exception is thrown from a handler, the exception is allowed to propagate through the throwing thread's invocation of `run()`, `run_one()`, `poll()` or `poll_one()`. No other threads that are calling any of these functions are affected. It is then the responsibility of the application to catch the exception.
-After the exception has been caught, the `run()`, `run_one()`, `poll()` or `poll_one()` call may be restarted [*without] the need for an intervening call to `reset()`. This allows the thread to rejoin the [link boost_asio.reference.io_service `io_service`] object's thread pool without impacting any other threads in the pool.
-For example:
+Performing an asynchronous wait:
- boost::asio::io_service io_service;
- ...
- for (;;)
+ void handler(const boost::system::error_code& error)
{
- try
- {
- io_service.run();
- break; // run() exited normally
- }
- catch (my_exception& e)
+ if (!error)
{
- // Deal with exception as appropriate.
+ // Timer expired.
}
}
+ ...
+ // Construct a timer with an absolute expiry time.
+ boost::asio::deadline_timer timer(io_service,
+ boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+ // Start an asynchronous wait.
+ timer.async_wait(handler);
-[heading Stopping the io_service from running out of work]
-
-
-Some applications may need to prevent an [link boost_asio.reference.io_service `io_service`] object's `run()` call from returning when there is no more work to do. For example, the [link boost_asio.reference.io_service `io_service`] may be being run in a background thread that is launched prior to the application's asynchronous operations. The `run()` call may be kept running by creating an object of type [link boost_asio.reference.io_service__work `io_service::work`]:
+[heading Changing an active deadline_timer's expiry time]
+
- boost::asio::io_service io_service;
- boost::asio::io_service::work work(io_service);
- ...
+Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
-To effect a shutdown, the application will then need to call the [link boost_asio.reference.io_service `io_service`] object's `stop()` member function. This will cause the [link boost_asio.reference.io_service `io_service`] `run()` call to return as soon as possible, abandoning unfinished operations and without permitting ready handlers to be dispatched.
+ void on_some_event()
+ {
+ if (my_timer.expires_from_now(seconds(5)) > 0)
+ {
+ // We managed to cancel the timer. Start new asynchronous wait.
+ my_timer.async_wait(on_timeout);
+ }
+ else
+ {
+ // Too late, timer has already expired!
+ }
+ }
-Alternatively, if the application requires that all operations and handlers be allowed to finish normally, the work object may be explicitly destroyed.
+ void on_timeout(const boost::system::error_code& e)
+ {
+ if (e != boost::asio::error::operation_aborted)
+ {
+ // Timer was not cancelled, take necessary action.
+ }
+ }
- boost::asio::io_service io_service;
- auto_ptr<boost::asio::io_service::work> work(
- new boost::asio::io_service::work(io_service));
- ...
- work.reset(); // Allow run() to exit.
+* The `boost::asio::basic_deadline_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
+* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
-[heading The io_service class and I/O services]
-
-Class [link boost_asio.reference.io_service `io_service`] implements an extensible, type-safe, polymorphic set of I/O services, indexed by service type. An object of class [link boost_asio.reference.io_service `io_service`] must be initialised before I/O objects such as sockets, resolvers and timers can be used. These I/O objects are distinguished by having constructors that accept an `io_service&` parameter.
-I/O services exist to manage the logical interface to the operating system on behalf of the I/O objects. In particular, there are resources that are shared across a class of I/O objects. For example, timers may be implemented in terms of a single timer queue. The I/O services manage these shared resources.
+[heading Requirements]
-Access to the services of an [link boost_asio.reference.io_service `io_service`] is via three function templates, `use_service()`, `add_service()` and `has_service()`.
+[*Header: ][^boost/asio/deadline_timer.hpp]
-In a call to `use_service<Service>()`, the type argument chooses a service, making available all members of the named type. If `Service` is not present in an [link boost_asio.reference.io_service `io_service`], an object of type `Service` is created and added to the [link boost_asio.reference.io_service `io_service`]. A C++ program can check if an [link boost_asio.reference.io_service `io_service`] implements a particular service with the function template `has_service<Service>()`.
+[*Convenience header: ][^boost/asio.hpp]
-Service objects may be explicitly added to an [link boost_asio.reference.io_service `io_service`] using the function template `add_service<Service>()`. If the `Service` is already present, the [link boost_asio.reference.service_already_exists `service_already_exists`] exception is thrown. If the owner of the service is not the same object as the [link boost_asio.reference.io_service `io_service`] parameter, the [link boost_asio.reference.invalid_service_owner `invalid_service_owner`] exception is thrown.
-Once a service reference is obtained from an [link boost_asio.reference.io_service `io_service`] object by calling `use_service()`, that reference remains usable as long as the owning [link boost_asio.reference.io_service `io_service`] object exists.
+[endsect]
-All I/O service implementations have [link boost_asio.reference.io_service__service `io_service::service`] as a public base class. Custom I/O services may be implemented by deriving from this class and then added to an [link boost_asio.reference.io_service `io_service`] using the facilities described above.
-[heading Requirements]
+[section:deadline_timer_service deadline_timer_service]
-[*Header: ][^boost/asio/io_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+Default service implementation for a timer.
-[section:add_service io_service::add_service]
+ template<
+ typename TimeType,
+ typename ``[link boost_asio.reference.TimeTraits TimeTraits]`` = boost::asio::time_traits<TimeType>>
+ class deadline_timer_service :
+ public io_service::service
-[indexterm2 add_service..io_service]
-Add a service object to the [link boost_asio.reference.io_service `io_service`].
+[heading Types]
+[table
+ [[Name][Description]]
- template<
- typename ``[link boost_asio.reference.Service Service]``>
- friend void add_service(
- io_service & ios,
- Service * svc);
+ [
+ [[link boost_asio.reference.deadline_timer_service.duration_type [*duration_type]]]
+ [The duration type. ]
+
+ ]
-This function is used to add a service to the [link boost_asio.reference.io_service `io_service`].
+ [
+ [[link boost_asio.reference.deadline_timer_service.implementation_type [*implementation_type]]]
+ [The implementation type of the deadline timer. ]
+
+ ]
-[heading Parameters]
-
+ [
-[variablelist
+ [[link boost_asio.reference.deadline_timer_service.time_type [*time_type]]]
+ [The time type. ]
-[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
+ ]
-[[svc][The service object. On success, ownership of the service object is transferred to the [link boost_asio.reference.io_service `io_service`]. When the [link boost_asio.reference.io_service `io_service`] object is destroyed, it will destroy the service object by performing:
-``
- delete static_cast<io_service::service*>(svc)
-``
-]]
+ [
-]
+ [[link boost_asio.reference.deadline_timer_service.traits_type [*traits_type]]]
+ [The time traits type. ]
+
+ ]
+]
-[heading Exceptions]
-
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[variablelist
+ [
+ [[link boost_asio.reference.deadline_timer_service.async_wait [*async_wait]]]
+ []
+ ]
-[[boost::asio::service_already_exists][Thrown if a service of the given type is already present in the [link boost_asio.reference.io_service `io_service`].]]
+ [
+ [[link boost_asio.reference.deadline_timer_service.cancel [*cancel]]]
+ [Cancel any asynchronous wait operations associated with the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous wait operation associated with the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.construct [*construct]]]
+ [Construct a new timer implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.deadline_timer_service [*deadline_timer_service]]]
+ [Construct a new timer service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.destroy [*destroy]]]
+ [Destroy a timer implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.expires_at [*expires_at]]]
+ [Get the expiry time for the timer as an absolute time.
-[[boost::asio::invalid_service_owner][Thrown if the service's owning [link boost_asio.reference.io_service `io_service`] is not the [link boost_asio.reference.io_service `io_service`] object specified by the ios parameter. ]]
+ Set the expiry time for the timer as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.expires_from_now [*expires_from_now]]]
+ [Get the expiry time for the timer relative to now.
+ Set the expiry time for the timer relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.wait [*wait]]]
+ []
+ ]
+
]
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.deadline_timer_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+]
[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
+[*Header: ][^boost/asio/deadline_timer_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:async_wait deadline_timer_service::async_wait]
+[indexterm2 async_wait..deadline_timer_service]
+ template<
+ typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
+ void async_wait(
+ implementation_type & impl,
+ WaitHandler handler);
-[section:dispatch io_service::dispatch]
-[indexterm2 dispatch..io_service]
-Request the [link boost_asio.reference.io_service `io_service`] to invoke the given handler.
+[endsect]
- template<
- typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
- void dispatch(
- CompletionHandler handler);
-This function is used to ask the [link boost_asio.reference.io_service `io_service`] to execute the given handler.
+[section:cancel deadline_timer_service::cancel]
-The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the `run()`, `run_one()`, `poll()` or `poll_one()` member functions is currently being invoked. The handler may be executed inside this function if the guarantee can be met.
+[indexterm2 cancel..deadline_timer_service]
+Cancel any asynchronous wait operations associated with the timer.
-[heading Parameters]
-
+ std::size_t cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[variablelist
-
-[[handler][The handler to be called. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler();
-``
-]]
-]
+[endsect]
-[heading Remarks]
-
-This function throws an exception only if:
-* the handler's `asio_handler_allocate` function; or
-
-
-* the handler's copy constructor
-
-throws an exception.
-
-
-[endsect]
+[section:cancel_one deadline_timer_service::cancel_one]
+[indexterm2 cancel_one..deadline_timer_service]
+Cancels one asynchronous wait operation associated with the timer.
-[section:fork_event io_service::fork_event]
+ std::size_t cancel_one(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[indexterm2 fork_event..io_service]
-Fork-related event notifications.
- enum fork_event
+[endsect]
-[indexterm2 fork_prepare..io_service]
-[indexterm2 fork_parent..io_service]
-[indexterm2 fork_child..io_service]
-[heading Values]
-[variablelist
- [
- [fork_prepare]
- [Notify the io_service that the process is about to fork. ]
- ]
+[section:construct deadline_timer_service::construct]
- [
- [fork_parent]
- [Notify the io_service that the process has forked and is the parent. ]
- ]
+[indexterm2 construct..deadline_timer_service]
+Construct a new timer implementation.
- [
- [fork_child]
- [Notify the io_service that the process has forked and is the child. ]
- ]
-]
+ void construct(
+ implementation_type & impl);
@@ -53210,608 +53106,678 @@
-[section:has_service io_service::has_service]
-
-[indexterm2 has_service..io_service]
-Determine if an [link boost_asio.reference.io_service `io_service`] contains a specified service type.
-
-
- template<
- typename ``[link boost_asio.reference.Service Service]``>
- friend bool has_service(
- io_service & ios);
+[section:deadline_timer_service deadline_timer_service::deadline_timer_service]
+[indexterm2 deadline_timer_service..deadline_timer_service]
+Construct a new timer service for the specified [link boost_asio.reference.io_service `io_service`].
-This function is used to determine whether the [link boost_asio.reference.io_service `io_service`] contains a service object corresponding to the given service type.
+ deadline_timer_service(
+ boost::asio::io_service & io_service);
-[heading Parameters]
-
-[variablelist
-
-[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
-]
+[endsect]
-[heading Return Value]
-
-A boolean indicating whether the [link boost_asio.reference.io_service `io_service`] contains the service.
+[section:destroy deadline_timer_service::destroy]
+[indexterm2 destroy..deadline_timer_service]
+Destroy a timer implementation.
-[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
+ void destroy(
+ implementation_type & impl);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:io_service io_service::io_service]
-
-[indexterm2 io_service..io_service]
-Constructor.
-
- ``[link boost_asio.reference.io_service.io_service.overload1 io_service]``();
- `` [''''»''' [link boost_asio.reference.io_service.io_service.overload1 more...]]``
+[section:duration_type deadline_timer_service::duration_type]
- explicit ``[link boost_asio.reference.io_service.io_service.overload2 io_service]``(
- std::size_t concurrency_hint);
- `` [''''»''' [link boost_asio.reference.io_service.io_service.overload2 more...]]``
+[indexterm2 duration_type..deadline_timer_service]
+The duration type.
-[section:overload1 io_service::io_service (1 of 2 overloads)]
+ typedef traits_type::duration_type duration_type;
-Constructor.
+[heading Requirements]
- io_service();
+[*Header: ][^boost/asio/deadline_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:expires_at deadline_timer_service::expires_at]
-[section:overload2 io_service::io_service (2 of 2 overloads)]
-
+[indexterm2 expires_at..deadline_timer_service]
+Get the expiry time for the timer as an absolute time.
-Constructor.
+ time_type ``[link boost_asio.reference.deadline_timer_service.expires_at.overload1 expires_at]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_at.overload1 more...]]``
- io_service(
- std::size_t concurrency_hint);
+Set the expiry time for the timer as an absolute time.
-Construct with a hint about the required level of concurrency.
+ std::size_t ``[link boost_asio.reference.deadline_timer_service.expires_at.overload2 expires_at]``(
+ implementation_type & impl,
+ const time_type & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_at.overload2 more...]]``
-[heading Parameters]
-
-[variablelist
-
-[[concurrency_hint][A suggestion to the implementation on how many threads it should allow to run simultaneously. ]]
+[section:overload1 deadline_timer_service::expires_at (1 of 2 overloads)]
-]
+Get the expiry time for the timer as an absolute time.
+ time_type expires_at(
+ const implementation_type & impl) const;
-[endsect]
[endsect]
-[section:notify_fork io_service::notify_fork]
-[indexterm2 notify_fork..io_service]
-Notify the [link boost_asio.reference.io_service `io_service`] of a fork-related event.
+[section:overload2 deadline_timer_service::expires_at (2 of 2 overloads)]
- void notify_fork(
- boost::asio::io_service::fork_event event);
+Set the expiry time for the timer as an absolute time.
-This function is used to inform the [link boost_asio.reference.io_service `io_service`] that the process is about to fork, or has just forked. This allows the [link boost_asio.reference.io_service `io_service`], and the services it contains, to perform any necessary housekeeping to ensure correct operation following a fork.
+ std::size_t expires_at(
+ implementation_type & impl,
+ const time_type & expiry_time,
+ boost::system::error_code & ec);
-This function must not be called while any other [link boost_asio.reference.io_service `io_service`] function, or any function on an I/O object associated with the [link boost_asio.reference.io_service `io_service`], is being called in another thread. It is, however, safe to call this function from within a completion handler, provided no other thread is accessing the [link boost_asio.reference.io_service `io_service`].
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[event][A fork-related event.]]
-]
+[endsect]
+[section:expires_from_now deadline_timer_service::expires_from_now]
-[heading Exceptions]
-
+[indexterm2 expires_from_now..deadline_timer_service]
+Get the expiry time for the timer relative to now.
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the notification fails the [link boost_asio.reference.io_service `io_service`] object should no longer be used and should be destroyed.]]
-]
+ duration_type ``[link boost_asio.reference.deadline_timer_service.expires_from_now.overload1 expires_from_now]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_from_now.overload1 more...]]``
-[heading Example]
-
-The following code illustrates how to incorporate the `notify_fork()` function:
+Set the expiry time for the timer relative to now.
- my_io_service.notify_fork(boost::asio::io_service::fork_prepare);
- if (fork() == 0)
- {
- // This is the child process.
- my_io_service.notify_fork(boost::asio::io_service::fork_child);
- }
- else
- {
- // This is the parent process.
- my_io_service.notify_fork(boost::asio::io_service::fork_parent);
- }
+
+ std::size_t ``[link boost_asio.reference.deadline_timer_service.expires_from_now.overload2 expires_from_now]``(
+ implementation_type & impl,
+ const duration_type & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.deadline_timer_service.expires_from_now.overload2 more...]]``
+[section:overload1 deadline_timer_service::expires_from_now (1 of 2 overloads)]
+Get the expiry time for the timer relative to now.
-[heading Remarks]
-
-For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, performs `svc->fork_service();`. When processing the fork\_prepare event, services are visited in reverse order of the beginning of service object lifetime. Otherwise, services are visited in order of the beginning of service object lifetime.
+ duration_type expires_from_now(
+ const implementation_type & impl) const;
[endsect]
-[section:poll io_service::poll]
-[indexterm2 poll..io_service]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
+[section:overload2 deadline_timer_service::expires_from_now (2 of 2 overloads)]
- std::size_t ``[link boost_asio.reference.io_service.poll.overload1 poll]``();
- `` [''''»''' [link boost_asio.reference.io_service.poll.overload1 more...]]``
+Set the expiry time for the timer relative to now.
- std::size_t ``[link boost_asio.reference.io_service.poll.overload2 poll]``(
+
+ std::size_t expires_from_now(
+ implementation_type & impl,
+ const duration_type & expiry_time,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.io_service.poll.overload2 more...]]``
-[section:overload1 io_service::poll (1 of 2 overloads)]
+[endsect]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
+[endsect]
- std::size_t poll();
+[section:get_io_service deadline_timer_service::get_io_service]
-The `poll()` function runs handlers that are ready to run, without blocking, until the [link boost_asio.reference.io_service `io_service`] has been stopped or there are no more ready handlers.
+['Inherited from io_service.]
-[heading Return Value]
-
-The number of handlers that were executed.
+[indexterm2 get_io_service..deadline_timer_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-[heading Exceptions]
-
+ boost::asio::io_service & get_io_service();
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
-]
+[endsect]
-[endsect]
+[section:id deadline_timer_service::id]
+[indexterm2 id..deadline_timer_service]
+The unique service identifier.
-[section:overload2 io_service::poll (2 of 2 overloads)]
+ static boost::asio::io_service::id id;
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
+[endsect]
- std::size_t poll(
- boost::system::error_code & ec);
-The `poll()` function runs handlers that are ready to run, without blocking, until the [link boost_asio.reference.io_service `io_service`] has been stopped or there are no more ready handlers.
+[section:implementation_type deadline_timer_service::implementation_type]
+[indexterm2 implementation_type..deadline_timer_service]
+The implementation type of the deadline timer.
-[heading Parameters]
-
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any.]]
+ typedef implementation_defined implementation_type;
-]
-[heading Return Value]
-
-The number of handlers that were executed.
+[heading Requirements]
+[*Header: ][^boost/asio/deadline_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
-
-[section:poll_one io_service::poll_one]
-[indexterm2 poll_one..io_service]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
+[section:time_type deadline_timer_service::time_type]
+[indexterm2 time_type..deadline_timer_service]
+The time type.
- std::size_t ``[link boost_asio.reference.io_service.poll_one.overload1 poll_one]``();
- `` [''''»''' [link boost_asio.reference.io_service.poll_one.overload1 more...]]``
- std::size_t ``[link boost_asio.reference.io_service.poll_one.overload2 poll_one]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.io_service.poll_one.overload2 more...]]``
+ typedef traits_type::time_type time_type;
-[section:overload1 io_service::poll_one (1 of 2 overloads)]
+[heading Requirements]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
+[*Header: ][^boost/asio/deadline_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
- std::size_t poll_one();
+[endsect]
-The `poll_one()` function runs at most one handler that is ready to run, without blocking.
-[heading Return Value]
-
-The number of handlers that were executed.
+[section:traits_type deadline_timer_service::traits_type]
+[indexterm2 traits_type..deadline_timer_service]
+The time traits type.
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
+ typedef TimeTraits traits_type;
-]
+[heading Requirements]
+[*Header: ][^boost/asio/deadline_timer_service.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:overload2 io_service::poll_one (2 of 2 overloads)]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
+[section:wait deadline_timer_service::wait]
+[indexterm2 wait..deadline_timer_service]
- std::size_t poll_one(
+ void wait(
+ implementation_type & impl,
boost::system::error_code & ec);
-The `poll_one()` function runs at most one handler that is ready to run, without blocking.
-
-
-[heading Parameters]
-
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of handlers that were executed.
+[endsect]
+[section:error__addrinfo_category error::addrinfo_category]
+[indexterm1 error::addrinfo_category]
-[endsect]
+ static const boost::system::error_category & addrinfo_category = boost::asio::error::get_addrinfo_category();
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
-[section:post io_service::post]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 post..io_service]
-Request the [link boost_asio.reference.io_service `io_service`] to invoke the given handler and return immediately.
+[endsect]
- template<
- typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
- void post(
- CompletionHandler handler);
-This function is used to ask the [link boost_asio.reference.io_service `io_service`] to execute the given handler, but without allowing the [link boost_asio.reference.io_service `io_service`] to call the handler from inside this function.
+[section:error__addrinfo_errors error::addrinfo_errors]
-The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the `run()`, `run_one()`, `poll()` or `poll_one()` member functions is currently being invoked.
+[indexterm1 error::addrinfo_errors]
+ enum addrinfo_errors
-[heading Parameters]
-
+[indexterm2 service_not_found..error::addrinfo_errors]
+[indexterm2 socket_type_not_supported..error::addrinfo_errors]
+[heading Values]
[variablelist
-
-[[handler][The handler to be called. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler();
-``
-]]
-
-]
+ [
+ [service_not_found]
+ [The service is not supported for the given socket type. ]
+ ]
-[heading Remarks]
-
-This function throws an exception only if:
+ [
+ [socket_type_not_supported]
+ [The socket type is not supported. ]
+ ]
+]
-* the handler's `asio_handler_allocate` function; or
+[heading Requirements]
-* the handler's copy constructor
+[*Header: ][^boost/asio/error.hpp]
-throws an exception.
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:reset io_service::reset]
+[section:error__basic_errors error::basic_errors]
-[indexterm2 reset..io_service]
-Reset the [link boost_asio.reference.io_service `io_service`] in preparation for a subsequent `run()` invocation.
+[indexterm1 error::basic_errors]
+ enum basic_errors
- void reset();
+[indexterm2 access_denied..error::basic_errors]
+[indexterm2 address_family_not_supported..error::basic_errors]
+[indexterm2 address_in_use..error::basic_errors]
+[indexterm2 already_connected..error::basic_errors]
+[indexterm2 already_started..error::basic_errors]
+[indexterm2 broken_pipe..error::basic_errors]
+[indexterm2 connection_aborted..error::basic_errors]
+[indexterm2 connection_refused..error::basic_errors]
+[indexterm2 connection_reset..error::basic_errors]
+[indexterm2 bad_descriptor..error::basic_errors]
+[indexterm2 fault..error::basic_errors]
+[indexterm2 host_unreachable..error::basic_errors]
+[indexterm2 in_progress..error::basic_errors]
+[indexterm2 interrupted..error::basic_errors]
+[indexterm2 invalid_argument..error::basic_errors]
+[indexterm2 message_size..error::basic_errors]
+[indexterm2 name_too_long..error::basic_errors]
+[indexterm2 network_down..error::basic_errors]
+[indexterm2 network_reset..error::basic_errors]
+[indexterm2 network_unreachable..error::basic_errors]
+[indexterm2 no_descriptors..error::basic_errors]
+[indexterm2 no_buffer_space..error::basic_errors]
+[indexterm2 no_memory..error::basic_errors]
+[indexterm2 no_permission..error::basic_errors]
+[indexterm2 no_protocol_option..error::basic_errors]
+[indexterm2 not_connected..error::basic_errors]
+[indexterm2 not_socket..error::basic_errors]
+[indexterm2 operation_aborted..error::basic_errors]
+[indexterm2 operation_not_supported..error::basic_errors]
+[indexterm2 shut_down..error::basic_errors]
+[indexterm2 timed_out..error::basic_errors]
+[indexterm2 try_again..error::basic_errors]
+[indexterm2 would_block..error::basic_errors]
+[heading Values]
+[variablelist
-This function must be called prior to any second or later set of invocations of the `run()`, `run_one()`, `poll()` or `poll_one()` functions when a previous invocation of these functions returned due to the [link boost_asio.reference.io_service `io_service`] being stopped or running out of work. After a call to `reset()`, the [link boost_asio.reference.io_service `io_service`] object's `stopped()` function will return `false`.
+ [
+ [access_denied]
+ [Permission denied. ]
+ ]
-This function must not be called while there are any unfinished calls to the `run()`, `run_one()`, `poll()` or `poll_one()` functions.
+ [
+ [address_family_not_supported]
+ [Address family not supported by protocol. ]
+ ]
+ [
+ [address_in_use]
+ [Address already in use. ]
+ ]
-[endsect]
+ [
+ [already_connected]
+ [Transport endpoint is already connected. ]
+ ]
+ [
+ [already_started]
+ [Operation already in progress. ]
+ ]
-[section:run io_service::run]
+ [
+ [broken_pipe]
+ [Broken pipe. ]
+ ]
-[indexterm2 run..io_service]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
+ [
+ [connection_aborted]
+ [A connection has been aborted. ]
+ ]
+ [
+ [connection_refused]
+ [Connection refused. ]
+ ]
- std::size_t ``[link boost_asio.reference.io_service.run.overload1 run]``();
- `` [''''»''' [link boost_asio.reference.io_service.run.overload1 more...]]``
+ [
+ [connection_reset]
+ [Connection reset by peer. ]
+ ]
- std::size_t ``[link boost_asio.reference.io_service.run.overload2 run]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.io_service.run.overload2 more...]]``
+ [
+ [bad_descriptor]
+ [Bad file descriptor. ]
+ ]
+ [
+ [fault]
+ [Bad address. ]
+ ]
-[section:overload1 io_service::run (1 of 2 overloads)]
+ [
+ [host_unreachable]
+ [No route to host. ]
+ ]
+ [
+ [in_progress]
+ [Operation now in progress. ]
+ ]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
+ [
+ [interrupted]
+ [Interrupted system call. ]
+ ]
+ [
+ [invalid_argument]
+ [Invalid argument. ]
+ ]
- std::size_t run();
+ [
+ [message_size]
+ [Message too long. ]
+ ]
+ [
+ [name_too_long]
+ [The name was too long. ]
+ ]
-The `run()` function blocks until all work has finished and there are no more handlers to be dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
+ [
+ [network_down]
+ [Network is down. ]
+ ]
-Multiple threads may call the `run()` function to set up a pool of threads from which the [link boost_asio.reference.io_service `io_service`] may execute handlers. All threads that are waiting in the pool are equivalent and the [link boost_asio.reference.io_service `io_service`] may choose any one of them to invoke a handler.
+ [
+ [network_reset]
+ [Network dropped connection on reset. ]
+ ]
-A normal exit from the `run()` function implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
+ [
+ [network_unreachable]
+ [Network is unreachable. ]
+ ]
+ [
+ [no_descriptors]
+ [Too many open files. ]
+ ]
-[heading Return Value]
-
-The number of handlers that were executed.
+ [
+ [no_buffer_space]
+ [No buffer space available. ]
+ ]
+ [
+ [no_memory]
+ [Cannot allocate memory. ]
+ ]
-[heading Exceptions]
-
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-
-]
-
-
-[heading Remarks]
-
-The `run()` function must not be called from a thread that is currently calling one of `run()`, `run_one()`, `poll()` or `poll_one()` on the same [link boost_asio.reference.io_service `io_service`] object.
+ [
+ [no_permission]
+ [Operation not permitted. ]
+ ]
-The `poll()` function may also be used to dispatch ready handlers, but without blocking.
+ [
+ [no_protocol_option]
+ [Protocol not available. ]
+ ]
+ [
+ [not_connected]
+ [Transport endpoint is not connected. ]
+ ]
-[endsect]
+ [
+ [not_socket]
+ [Socket operation on non-socket. ]
+ ]
+ [
+ [operation_aborted]
+ [Operation cancelled. ]
+ ]
+ [
+ [operation_not_supported]
+ [Operation not supported. ]
+ ]
-[section:overload2 io_service::run (2 of 2 overloads)]
+ [
+ [shut_down]
+ [Cannot send after transport endpoint shutdown. ]
+ ]
+ [
+ [timed_out]
+ [Connection timed out. ]
+ ]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
+ [
+ [try_again]
+ [Resource temporarily unavailable. ]
+ ]
+ [
+ [would_block]
+ [The socket is marked non-blocking and the requested operation would block. ]
+ ]
- std::size_t run(
- boost::system::error_code & ec);
+]
-The `run()` function blocks until all work has finished and there are no more handlers to be dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
+[heading Requirements]
-Multiple threads may call the `run()` function to set up a pool of threads from which the [link boost_asio.reference.io_service `io_service`] may execute handlers. All threads that are waiting in the pool are equivalent and the [link boost_asio.reference.io_service `io_service`] may choose any one of them to invoke a handler.
+[*Header: ][^boost/asio/error.hpp]
-A normal exit from the `run()` function implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[section:error__get_addrinfo_category error::get_addrinfo_category]
-[heading Return Value]
-
-The number of handlers that were executed.
+[indexterm1 error::get_addrinfo_category]
+ const boost::system::error_category & get_addrinfo_category();
-[heading Remarks]
-
-The `run()` function must not be called from a thread that is currently calling one of `run()`, `run_one()`, `poll()` or `poll_one()` on the same [link boost_asio.reference.io_service `io_service`] object.
-The `poll()` function may also be used to dispatch ready handlers, but without blocking.
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:run_one io_service::run_one]
-
-[indexterm2 run_one..io_service]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
- std::size_t ``[link boost_asio.reference.io_service.run_one.overload1 run_one]``();
- `` [''''»''' [link boost_asio.reference.io_service.run_one.overload1 more...]]``
+[section:error__get_misc_category error::get_misc_category]
- std::size_t ``[link boost_asio.reference.io_service.run_one.overload2 run_one]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.io_service.run_one.overload2 more...]]``
+[indexterm1 error::get_misc_category]
+ const boost::system::error_category & get_misc_category();
-[section:overload1 io_service::run_one (1 of 2 overloads)]
+[heading Requirements]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
+[*Header: ][^boost/asio/error.hpp]
+[*Convenience header: ][^boost/asio.hpp]
- std::size_t run_one();
+[endsect]
-The `run_one()` function blocks until one handler has been dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
-[heading Return Value]
-
-The number of handlers that were executed. A zero return value implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
+[section:error__get_netdb_category error::get_netdb_category]
+[indexterm1 error::get_netdb_category]
-[heading Exceptions]
-
+ const boost::system::error_category & get_netdb_category();
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
-]
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 io_service::run_one (2 of 2 overloads)]
-
+[section:error__get_ssl_category error::get_ssl_category]
-Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
+[indexterm1 error::get_ssl_category]
+ const boost::system::error_category & get_ssl_category();
- std::size_t run_one(
- boost::system::error_code & ec);
+[heading Requirements]
-The `run_one()` function blocks until one handler has been dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
+[*Header: ][^boost/asio/ssl/error.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[heading Return Value]
-
-The number of handlers that were executed. A zero return value implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
-The number of handlers that were executed.
+[endsect]
+[section:error__get_system_category error::get_system_category]
-[endsect]
+[indexterm1 error::get_system_category]
+ const boost::system::error_category & get_system_category();
-[endsect]
+[heading Requirements]
-[section:stop io_service::stop]
+[*Header: ][^boost/asio/error.hpp]
-[indexterm2 stop..io_service]
-Stop the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
+[*Convenience header: ][^boost/asio.hpp]
- void stop();
+[endsect]
-This function does not block, but instead simply signals the [link boost_asio.reference.io_service `io_service`] to stop. All invocations of its `run()` or `run_one()` member functions should return as soon as possible. Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately until `reset()` is called.
+[section:error__make_error_code error::make_error_code]
+[indexterm1 error::make_error_code]
+
+ boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload1 make_error_code]``(
+ basic_errors e);
+ `` [''''»''' [link boost_asio.reference.error__make_error_code.overload1 more...]]``
-[endsect]
+ boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload2 make_error_code]``(
+ netdb_errors e);
+ `` [''''»''' [link boost_asio.reference.error__make_error_code.overload2 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload3 make_error_code]``(
+ addrinfo_errors e);
+ `` [''''»''' [link boost_asio.reference.error__make_error_code.overload3 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload4 make_error_code]``(
+ misc_errors e);
+ `` [''''»''' [link boost_asio.reference.error__make_error_code.overload4 more...]]``
-[section:stopped io_service::stopped]
+ boost::system::error_code ``[link boost_asio.reference.error__make_error_code.overload5 make_error_code]``(
+ ssl_errors e);
+ `` [''''»''' [link boost_asio.reference.error__make_error_code.overload5 more...]]``
-[indexterm2 stopped..io_service]
-Determine whether the [link boost_asio.reference.io_service `io_service`] object has been stopped.
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
- bool stopped() const;
+[*Convenience header: ][^boost/asio.hpp]
-This function is used to determine whether an [link boost_asio.reference.io_service `io_service`] object has been stopped, either through an explicit call to `stop()`, or due to running out of work. When an [link boost_asio.reference.io_service `io_service`] object is stopped, calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately without invoking any handlers.
+[section:overload1 error::make_error_code (1 of 5 overloads)]
-[heading Return Value]
-
-`true` if the [link boost_asio.reference.io_service `io_service`] object is stopped, otherwise `false`.
+ boost::system::error_code make_error_code(
+ basic_errors e);
@@ -53819,275 +53785,257 @@
-[section:use_service io_service::use_service]
+[section:overload2 error::make_error_code (2 of 5 overloads)]
-[indexterm2 use_service..io_service]
-Obtain the service object corresponding to the given type.
- template<
- typename ``[link boost_asio.reference.Service Service]``>
- friend Service & use_service(
- io_service & ios);
+ boost::system::error_code make_error_code(
+ netdb_errors e);
-This function is used to locate a service object that corresponds to the given service type. If there is no existing implementation of the service, then the [link boost_asio.reference.io_service `io_service`] will create a new instance of the service.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
-]
+[section:overload3 error::make_error_code (3 of 5 overloads)]
-[heading Return Value]
-
-The service interface implementing the specified service type. Ownership of the service interface is not transferred to the caller.
+ boost::system::error_code make_error_code(
+ addrinfo_errors e);
-[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:overload4 error::make_error_code (4 of 5 overloads)]
-[section:wrap io_service::wrap]
+ boost::system::error_code make_error_code(
+ misc_errors e);
-[indexterm2 wrap..io_service]
-Create a new handler that automatically dispatches the wrapped handler on the [link boost_asio.reference.io_service `io_service`].
- template<
- typename ``[link boost_asio.reference.Handler Handler]``>
- unspecified wrap(
- Handler handler);
+[endsect]
-This function is used to create a new handler function object that, when invoked, will automatically pass the wrapped handler to the [link boost_asio.reference.io_service `io_service`] object's dispatch function.
+[section:overload5 error::make_error_code (5 of 5 overloads)]
-[heading Parameters]
-
-[variablelist
-
-[[handler][The handler to be wrapped. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler(A1 a1, ... An an);
-``
-]]
-]
+ boost::system::error_code make_error_code(
+ ssl_errors e);
-[heading Return Value]
-
-A function object that, when invoked, passes the wrapped handler to the [link boost_asio.reference.io_service `io_service`] object's dispatch function. Given a function object with the signature:
- R f(A1 a1, ... An an);
+[endsect]
-If this function object is passed to the wrap function like so:
+[endsect]
- io_service.wrap(f);
+[section:error__misc_category error::misc_category]
-then the return value is a function object with the signature
+[indexterm1 error::misc_category]
- void g(A1 a1, ... An an);
+ static const boost::system::error_category & misc_category = boost::asio::error::get_misc_category();
-that, when invoked, executes code equivalent to:
+[heading Requirements]
- io_service.dispatch(boost::bind(f, a1, ... an));
+[*Header: ][^boost/asio/error.hpp]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
+[section:error__misc_errors error::misc_errors]
-[endsect]
+[indexterm1 error::misc_errors]
+ enum misc_errors
+[indexterm2 already_open..error::misc_errors]
+[indexterm2 eof..error::misc_errors]
+[indexterm2 not_found..error::misc_errors]
+[indexterm2 fd_set_failure..error::misc_errors]
-[section:_io_service io_service::~io_service]
+[heading Values]
+[variablelist
-[indexterm2 ~io_service..io_service]
-Destructor.
+ [
+ [already_open]
+ [Already open. ]
+ ]
+ [
+ [eof]
+ [End of file or stream. ]
+ ]
- ~io_service();
+ [
+ [not_found]
+ [Element not found. ]
+ ]
+
+ [
+ [fd_set_failure]
+ [The descriptor cannot fit into the select system call's fd_set. ]
+ ]
+]
-On destruction, the [link boost_asio.reference.io_service `io_service`] performs the following sequence of operations:
+[heading Requirements]
-* For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, in reverse order of the beginning of service object lifetime, performs `svc->shutdown_service()`.
+[*Header: ][^boost/asio/error.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-* Uninvoked handler objects that were scheduled for deferred invocation on the [link boost_asio.reference.io_service `io_service`], or any associated strand, are destroyed.
+[endsect]
-* For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, in reverse order of the beginning of service object lifetime, performs `delete static_cast<io_service::service*>(svc)`.
-[heading Remarks]
-
-The destruction sequence described above permits programs to simplify their resource management by using `shared_ptr<>`. Where an object's lifetime is tied to the lifetime of a connection (or some other sequence of asynchronous operations), a `shared_ptr` to the object would be bound into the handlers for all asynchronous operations associated with it. This works as follows:
+[section:error__netdb_category error::netdb_category]
+[indexterm1 error::netdb_category]
-* When a single connection ends, all associated asynchronous operations complete. The corresponding handler objects are destroyed, and all `shared_ptr` references to the objects are destroyed.
+ static const boost::system::error_category & netdb_category = boost::asio::error::get_netdb_category();
-* To shut down the whole program, the [link boost_asio.reference.io_service `io_service`] function `stop()` is called to terminate any `run()` calls as soon as possible. The [link boost_asio.reference.io_service `io_service`] destructor defined above destroys all handlers, causing all `shared_ptr` references to all connection objects to be destroyed.
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
+[section:error__netdb_errors error::netdb_errors]
-[section:io_service__id io_service::id]
+[indexterm1 error::netdb_errors]
+ enum netdb_errors
-Class used to uniquely identify a service.
+[indexterm2 host_not_found..error::netdb_errors]
+[indexterm2 host_not_found_try_again..error::netdb_errors]
+[indexterm2 no_data..error::netdb_errors]
+[indexterm2 no_recovery..error::netdb_errors]
+[heading Values]
+[variablelist
- class id :
- noncopyable
+ [
+ [host_not_found]
+ [Host not found (authoritative). ]
+ ]
+ [
+ [host_not_found_try_again]
+ [Host not found (non-authoritative). ]
+ ]
-[heading Member Functions]
-[table
- [[Name][Description]]
+ [
+ [no_data]
+ [The query is valid but does not have associated address data. ]
+ ]
[
- [[link boost_asio.reference.io_service__id.id [*id]]]
- [Constructor. ]
+ [no_recovery]
+ [A non-recoverable error occurred. ]
]
-
+
]
+
[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
+[*Header: ][^boost/asio/error.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:id io_service::id::id]
+[endsect]
-[indexterm2 id..io_service::id]
-Constructor.
- id();
+[section:error__ssl_category error::ssl_category]
+[indexterm1 error::ssl_category]
+ static const boost::system::error_category & ssl_category = boost::asio::error::get_ssl_category();
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/error.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[section:io_service__service io_service::service]
+[endsect]
-Base class for all [link boost_asio.reference.io_service `io_service`] services.
- class service :
- noncopyable
+[section:error__ssl_errors error::ssl_errors]
+[indexterm1 error::ssl_errors]
-[heading Member Functions]
-[table
- [[Name][Description]]
+ enum ssl_errors
- [
- [[link boost_asio.reference.io_service__service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[heading Requirements]
- [
- [[link boost_asio.reference.io_service__service.service [*service]]]
- [Constructor. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__service._service [*~service]]]
- [Destructor. ]
- ]
-
-]
+[*Header: ][^boost/asio/ssl/error.hpp]
-[heading Private Member Functions]
-[table
- [[Name][Description]]
+[*Convenience header: ][^boost/asio/ssl.hpp]
- [
- [[link boost_asio.reference.io_service__service.fork_service [*fork_service]]]
- [Handle notification of a fork-related event to perform any necessary housekeeping. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__service.shutdown_service [*shutdown_service]]]
- [Destroy all user-defined handler objects owned by the service. ]
- ]
-
-]
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/io_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:error__system_category error::system_category]
-[section:get_io_service io_service::service::get_io_service]
+[indexterm1 error::system_category]
-[indexterm2 get_io_service..io_service::service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ static const boost::system::error_category & system_category = boost::asio::error::get_system_category();
- boost::asio::io_service & get_io_service();
+[heading Requirements]
+[*Header: ][^boost/asio/error.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:service io_service::service::service]
+[section:has_service has_service]
-[indexterm2 service..io_service::service]
-Constructor.
+[indexterm1 has_service]
+ template<
+ typename ``[link boost_asio.reference.Service Service]``>
+ bool has_service(
+ io_service & ios);
- service(
- boost::asio::io_service & owner);
+This function is used to determine whether the [link boost_asio.reference.io_service `io_service`] contains a service object corresponding to the given service type.
[heading Parameters]
@@ -54095,694 +54043,792 @@
[variablelist
-[[owner][The [link boost_asio.reference.io_service `io_service`] object that owns the service. ]]
+[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
]
+[heading Return Value]
+
+A boolean indicating whether the [link boost_asio.reference.io_service `io_service`] contains the service.
-[endsect]
-
-
-
-[section:_service io_service::service::~service]
-
-[indexterm2 ~service..io_service::service]
-Destructor.
+[heading Requirements]
- virtual ~service();
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:fork_service io_service::service::fork_service]
-
-[indexterm2 fork_service..io_service::service]
-Handle notification of a fork-related event to perform any necessary housekeeping.
-
-
- virtual void fork_service(
- boost::asio::io_service::fork_event event);
-
-
-This function is not a pure virtual so that services only have to implement it if necessary. The default implementation does nothing.
-
-
-[endsect]
+[section:high_resolution_timer high_resolution_timer]
+[indexterm1 high_resolution_timer]
+Typedef for a timer based on the high resolution clock.
-[section:shutdown_service io_service::service::shutdown_service]
+ typedef basic_waitable_timer< chrono::high_resolution_clock > high_resolution_timer;
-[indexterm2 shutdown_service..io_service::service]
-Destroy all user-defined handler objects owned by the service.
+[heading Types]
+[table
+ [[Name][Description]]
- void shutdown_service();
+ [
+ [[link boost_asio.reference.basic_waitable_timer.clock_type [*clock_type]]]
+ [The clock type. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_waitable_timer.duration [*duration]]]
+ [The duration type of the clock. ]
+
+ ]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
-[endsect]
+ [
-[section:io_service__strand io_service::strand]
+ [[link boost_asio.reference.basic_waitable_timer.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+ [
-Provides serialised handler execution.
+ [[link boost_asio.reference.basic_waitable_timer.time_point [*time_point]]]
+ [The time point type of the clock. ]
+
+ ]
+ [
- class strand
+ [[link boost_asio.reference.basic_waitable_timer.traits_type [*traits_type]]]
+ [The wait traits type. ]
+
+ ]
+]
[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.io_service__strand.dispatch [*dispatch]]]
- [Request the strand to invoke the given handler. ]
+ [[link boost_asio.reference.basic_waitable_timer.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the timer. ]
]
[
- [[link boost_asio.reference.io_service__strand.get_io_service [*get_io_service]]]
- [Get the io_service associated with the strand. ]
+ [[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer [*basic_waitable_timer]]]
+ [Constructor.
+
+ Constructor to set a particular expiry time as an absolute time.
+
+ Constructor to set a particular expiry time relative to now. ]
]
[
- [[link boost_asio.reference.io_service__strand.post [*post]]]
- [Request the strand to invoke the given handler and return immediately. ]
+ [[link boost_asio.reference.basic_waitable_timer.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the timer. ]
]
[
- [[link boost_asio.reference.io_service__strand.strand [*strand]]]
- [Constructor. ]
+ [[link boost_asio.reference.basic_waitable_timer.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous operation that is waiting on the timer. ]
]
[
- [[link boost_asio.reference.io_service__strand.wrap [*wrap]]]
- [Create a new handler that automatically dispatches the wrapped handler on the strand. ]
+ [[link boost_asio.reference.basic_waitable_timer.expires_at [*expires_at]]]
+ [Get the timer's expiry time as an absolute time.
+
+ Set the timer's expiry time as an absolute time. ]
]
[
- [[link boost_asio.reference.io_service__strand._strand [*~strand]]]
- [Destructor. ]
+ [[link boost_asio.reference.basic_waitable_timer.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
+
+ Set the timer's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.wait [*wait]]]
+ [Perform a blocking wait on the timer. ]
]
]
-The [link boost_asio.reference.io_service__strand `io_service::strand`] class provides the ability to post and dispatch handlers with the guarantee that none of those handlers will execute concurrently.
-
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[heading Order of handler invocation]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
-Given:
-
-
-* a strand object `s`
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
-* an object `a` meeting completion handler requirements
+ [
+ [[link boost_asio.reference.basic_waitable_timer.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
-* an object `a1` which is an arbitrary copy of `a` made by the implementation
+]
+The [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
-* an object `b` meeting completion handler requirements
+A waitable timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
+Most applications will use the boost::asio::waitable\_timer typedef.
-* an object `b1` which is an arbitrary copy of `b` made by the implementation
-if any of the following conditions are true:
+[heading Remarks]
+
+This waitable timer functionality is for use with the C++11 standard library's `<chrono>` facility, or with the Boost.Chrono library.
-* `s.post(a)` happens-before `s.post(b)`
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-* `s.post(a)` happens-before `s.dispatch(b)`, where the latter is performed outside the strand
+[heading Examples]
+
+Performing a blocking wait:
-* `s.dispatch(a)` happens-before `s.post(b)`, where the former is performed outside the strand
+ // Construct a timer without setting an expiry time.
+ boost::asio::waitable_timer timer(io_service);
+ // Set an expiry time relative to now.
+ timer.expires_from_now(boost::posix_time::seconds(5));
-* `s.dispatch(a)` happens-before `s.dispatch(b)`, where both are performed outside the strand
+ // Wait for the timer to expire.
+ timer.wait();
-then `asio_handler_invoke(a1, &a1)` happens-before `asio_handler_invoke(b1, &b1)`.
-Note that in the following case:
- async_op_1(..., s.wrap(a));
- async_op_2(..., s.wrap(b));
-the completion of the first async operation will perform `s.dispatch(a)`, and the second will perform `s.dispatch(b)`, but the order in which those are performed is unspecified. That is, you cannot state whether one happens-before the other. Therefore none of the above conditions are met and no ordering guarantee is made.
+Performing an asynchronous wait:
+ void handler(const boost::system::error_code& error)
+ {
+ if (!error)
+ {
+ // Timer expired.
+ }
+ }
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+ ...
-[*Shared] [*objects:] Safe.
+ // Construct a timer with an absolute expiry time.
+ boost::asio::waitable_timer timer(io_service,
+ boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+ // Start an asynchronous wait.
+ timer.async_wait(handler);
-[heading Requirements]
-[*Header: ][^boost/asio/strand.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Changing an active waitable_timer's expiry time]
+
-[section:dispatch io_service::strand::dispatch]
+Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
-[indexterm2 dispatch..io_service::strand]
-Request the strand to invoke the given handler.
- template<
- typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
- void dispatch(
- CompletionHandler handler);
+ void on_some_event()
+ {
+ if (my_timer.expires_from_now(seconds(5)) > 0)
+ {
+ // We managed to cancel the timer. Start new asynchronous wait.
+ my_timer.async_wait(on_timeout);
+ }
+ else
+ {
+ // Too late, timer has already expired!
+ }
+ }
+ void on_timeout(const boost::system::error_code& e)
+ {
+ if (e != boost::asio::error::operation_aborted)
+ {
+ // Timer was not cancelled, take necessary action.
+ }
+ }
-This function is used to ask the strand to execute the given handler.
-The strand object guarantees that handlers posted or dispatched through the strand will not be executed concurrently. The handler may be executed inside this function if the guarantee can be met. If this function is called from within a handler that was posted or dispatched through the same strand, then the new handler will be executed immediately.
-The strand's guarantee is in addition to the guarantee provided by the underlying [link boost_asio.reference.io_service `io_service`]. The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the io\_service's run member function is currently being invoked.
-[heading Parameters]
-
+* The `boost::asio::basic_waitable_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
-[variablelist
-
-[[handler][The handler to be called. The strand will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler();
-``
-]]
-]
+* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
-[endsect]
+This typedef uses the C++11 `<chrono>` standard library facility, if available. Otherwise, it may use the Boost.Chrono library. To explicitly utilise Boost.Chrono, use the [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] template directly:
+ typedef basic_waitable_timer<boost::chrono::high_resolution_clock> timer;
-[section:get_io_service io_service::strand::get_io_service]
-[indexterm2 get_io_service..io_service::strand]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the strand.
+[heading Requirements]
- boost::asio::io_service & get_io_service();
+[*Header: ][^boost/asio/high_resolution_timer.hpp]
+[*Convenience header: ]None
-This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the strand uses to dispatch handlers for asynchronous operations.
+[endsect]
-[heading Return Value]
-
-A reference to the [link boost_asio.reference.io_service `io_service`] object that the strand will use to dispatch handlers. Ownership is not transferred to the caller.
+[section:invalid_service_owner invalid_service_owner]
+Exception thrown when trying to add a service object to an [link boost_asio.reference.io_service `io_service`] where the service has a different owner.
-[endsect]
+ class invalid_service_owner
-[section:post io_service::strand::post]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[indexterm2 post..io_service::strand]
-Request the strand to invoke the given handler and return immediately.
+ [
+ [[link boost_asio.reference.invalid_service_owner.invalid_service_owner [*invalid_service_owner]]]
+ []
+ ]
+
+]
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
- void post(
- CompletionHandler handler);
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-This function is used to ask the strand to execute the given handler, but without allowing the strand to call the handler from inside this function.
-The strand object guarantees that handlers posted or dispatched through the strand will not be executed concurrently. The strand's guarantee is in addition to the guarantee provided by the underlying [link boost_asio.reference.io_service `io_service`]. The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the io\_service's run member function is currently being invoked.
+[section:invalid_service_owner invalid_service_owner::invalid_service_owner]
+[indexterm2 invalid_service_owner..invalid_service_owner]
-[heading Parameters]
-
+ invalid_service_owner();
-[variablelist
-
-[[handler][The handler to be called. The strand will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler();
-``
-]]
-]
+[endsect]
[endsect]
+[section:io_service io_service]
-[section:strand io_service::strand::strand]
+Provides core I/O functionality.
-[indexterm2 strand..io_service::strand]
-Constructor.
+ class io_service :
+ noncopyable
- strand(
- boost::asio::io_service & io_service);
+[heading Types]
+[table
+ [[Name][Description]]
-Constructs the strand.
+ [
+ [[link boost_asio.reference.io_service__id [*id]]]
+ [Class used to uniquely identify a service. ]
+
+ ]
-[heading Parameters]
-
+ [
-[variablelist
+ [[link boost_asio.reference.io_service__service [*service]]]
+ [Base class for all io_service services. ]
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the strand will use to dispatch handlers that are ready to be run. ]]
-
-]
+ ]
+ [
+ [[link boost_asio.reference.io_service__strand [*strand]]]
+ [Provides serialised handler execution. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.io_service__work [*work]]]
+ [Class to inform the io_service when it has work to do. ]
+
+ ]
+ [
+ [[link boost_asio.reference.io_service.fork_event [*fork_event]]]
+ [Fork-related event notifications. ]
+
+ ]
-[section:wrap io_service::strand::wrap]
+]
-[indexterm2 wrap..io_service::strand]
-Create a new handler that automatically dispatches the wrapped handler on the strand.
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.io_service.dispatch [*dispatch]]]
+ [Request the io_service to invoke the given handler. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.io_service [*io_service]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.notify_fork [*notify_fork]]]
+ [Notify the io_service of a fork-related event. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.poll [*poll]]]
+ [Run the io_service object's event processing loop to execute ready handlers. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.poll_one [*poll_one]]]
+ [Run the io_service object's event processing loop to execute one ready handler. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.post [*post]]]
+ [Request the io_service to invoke the given handler and return immediately. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.reset [*reset]]]
+ [Reset the io_service in preparation for a subsequent run() invocation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.run [*run]]]
+ [Run the io_service object's event processing loop. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.run_one [*run_one]]]
+ [Run the io_service object's event processing loop to execute at most one handler. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.stop [*stop]]]
+ [Stop the io_service object's event processing loop. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.stopped [*stopped]]]
+ [Determine whether the io_service object has been stopped. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.wrap [*wrap]]]
+ [Create a new handler that automatically dispatches the wrapped handler on the io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service._io_service [*~io_service]]]
+ [Destructor. ]
+ ]
+
+]
- template<
- typename ``[link boost_asio.reference.Handler Handler]``>
- unspecified wrap(
- Handler handler);
+[heading Friends]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.io_service.add_service [*add_service]]]
+ [Add a service object to the io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.has_service [*has_service]]]
+ [Determine if an io_service contains a specified service type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service.use_service [*use_service]]]
+ [Obtain the service object corresponding to the given type. ]
+ ]
+
+]
-This function is used to create a new handler function object that, when invoked, will automatically pass the wrapped handler to the strand's dispatch function.
+The [link boost_asio.reference.io_service `io_service`] class provides the core I/O functionality for users of the asynchronous I/O objects, including:
-[heading Parameters]
-
+* `boost::asio::ip::tcp::socket`
-[variablelist
-
-[[handler][The handler to be wrapped. The strand will make a copy of the handler object as required. The function signature of the handler must be:
-``
- void handler(A1 a1, ... An an);
-``
-]]
+* `boost::asio::ip::tcp::acceptor`
-]
+* `boost::asio::ip::udp::socket`
+* [link boost_asio.reference.deadline_timer `deadline_timer`].
-[heading Return Value]
-
-A function object that, when invoked, passes the wrapped handler to the strand's dispatch function. Given a function object with the signature:
+The [link boost_asio.reference.io_service `io_service`] class also includes facilities intended for developers of custom asynchronous services.
- R f(A1 a1, ... An an);
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-If this function object is passed to the wrap function like so:
+[*Shared] [*objects:] Safe, with the specific exceptions of the `reset()` and `notify_fork()` functions. Calling `reset()` while there are unfinished `run()`, `run_one()`, `poll()` or `poll_one()` calls results in undefined behaviour. The `notify_fork()` function should not be called while any [link boost_asio.reference.io_service `io_service`] function, or any function on an I/O object that is associated with the [link boost_asio.reference.io_service `io_service`], is being called in another thread.
- strand.wrap(f);
-then the return value is a function object with the signature
+[heading Synchronous and asynchronous operations]
+
- void g(A1 a1, ... An an);
+Synchronous operations on I/O objects implicitly run the [link boost_asio.reference.io_service `io_service`] object for an individual operation. The [link boost_asio.reference.io_service `io_service`] functions `run()`, `run_one()`, `poll()` or `poll_one()` must be called for the [link boost_asio.reference.io_service `io_service`] to perform asynchronous operations on behalf of a C++ program. Notification that an asynchronous operation has completed is delivered by invocation of the associated handler. Handlers are invoked only by a thread that is currently calling any overload of `run()`, `run_one()`, `poll()` or `poll_one()` for the [link boost_asio.reference.io_service `io_service`].
-that, when invoked, executes code equivalent to:
- strand.dispatch(boost::bind(f, a1, ... an));
+[heading Effect of exceptions thrown from handlers]
+
+If an exception is thrown from a handler, the exception is allowed to propagate through the throwing thread's invocation of `run()`, `run_one()`, `poll()` or `poll_one()`. No other threads that are calling any of these functions are affected. It is then the responsibility of the application to catch the exception.
+After the exception has been caught, the `run()`, `run_one()`, `poll()` or `poll_one()` call may be restarted [*without] the need for an intervening call to `reset()`. This allows the thread to rejoin the [link boost_asio.reference.io_service `io_service`] object's thread pool without impacting any other threads in the pool.
+For example:
-[endsect]
+ boost::asio::io_service io_service;
+ ...
+ for (;;)
+ {
+ try
+ {
+ io_service.run();
+ break; // run() exited normally
+ }
+ catch (my_exception& e)
+ {
+ // Deal with exception as appropriate.
+ }
+ }
-[section:_strand io_service::strand::~strand]
-[indexterm2 ~strand..io_service::strand]
-Destructor.
+[heading Stopping the io_service from running out of work]
+
- ~strand();
+Some applications may need to prevent an [link boost_asio.reference.io_service `io_service`] object's `run()` call from returning when there is no more work to do. For example, the [link boost_asio.reference.io_service `io_service`] may be being run in a background thread that is launched prior to the application's asynchronous operations. The `run()` call may be kept running by creating an object of type [link boost_asio.reference.io_service__work `io_service::work`]:
-Destroys a strand.
-Handlers posted through the strand that have not yet been invoked will still be dispatched in a way that meets the guarantee of non-concurrency.
+ boost::asio::io_service io_service;
+ boost::asio::io_service::work work(io_service);
+ ...
-[endsect]
-[endsect]
+To effect a shutdown, the application will then need to call the [link boost_asio.reference.io_service `io_service`] object's `stop()` member function. This will cause the [link boost_asio.reference.io_service `io_service`] `run()` call to return as soon as possible, abandoning unfinished operations and without permitting ready handlers to be dispatched.
-[section:io_service__work io_service::work]
+Alternatively, if the application requires that all operations and handlers be allowed to finish normally, the work object may be explicitly destroyed.
-Class to inform the [link boost_asio.reference.io_service `io_service`] when it has work to do.
+ boost::asio::io_service io_service;
+ auto_ptr<boost::asio::io_service::work> work(
+ new boost::asio::io_service::work(io_service));
+ ...
+ work.reset(); // Allow run() to exit.
- class work
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.io_service__work.get_io_service [*get_io_service]]]
- [Get the io_service associated with the work. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__work.work [*work]]]
- [Constructor notifies the io_service that work is starting.
- Copy constructor notifies the io_service that work is starting. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__work._work [*~work]]]
- [Destructor notifies the io_service that the work is complete. ]
- ]
+[heading The io_service class and I/O services]
-]
-The work class is used to inform the [link boost_asio.reference.io_service `io_service`] when work starts and finishes. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while work is underway, and that it does exit when there is no unfinished work remaining.
-The work class is copy-constructible so that it may be used as a data member in a handler class. It is not assignable.
+Class [link boost_asio.reference.io_service `io_service`] implements an extensible, type-safe, polymorphic set of I/O services, indexed by service type. An object of class [link boost_asio.reference.io_service `io_service`] must be initialised before I/O objects such as sockets, resolvers and timers can be used. These I/O objects are distinguished by having constructors that accept an `io_service&` parameter.
-[heading Requirements]
+I/O services exist to manage the logical interface to the operating system on behalf of the I/O objects. In particular, there are resources that are shared across a class of I/O objects. For example, timers may be implemented in terms of a single timer queue. The I/O services manage these shared resources.
-[*Header: ][^boost/asio/io_service.hpp]
+Access to the services of an [link boost_asio.reference.io_service `io_service`] is via three function templates, `use_service()`, `add_service()` and `has_service()`.
-[*Convenience header: ][^boost/asio.hpp]
+In a call to `use_service<Service>()`, the type argument chooses a service, making available all members of the named type. If `Service` is not present in an [link boost_asio.reference.io_service `io_service`], an object of type `Service` is created and added to the [link boost_asio.reference.io_service `io_service`]. A C++ program can check if an [link boost_asio.reference.io_service `io_service`] implements a particular service with the function template `has_service<Service>()`.
+Service objects may be explicitly added to an [link boost_asio.reference.io_service `io_service`] using the function template `add_service<Service>()`. If the `Service` is already present, the [link boost_asio.reference.service_already_exists `service_already_exists`] exception is thrown. If the owner of the service is not the same object as the [link boost_asio.reference.io_service `io_service`] parameter, the [link boost_asio.reference.invalid_service_owner `invalid_service_owner`] exception is thrown.
-[section:get_io_service io_service::work::get_io_service]
+Once a service reference is obtained from an [link boost_asio.reference.io_service `io_service`] object by calling `use_service()`, that reference remains usable as long as the owning [link boost_asio.reference.io_service `io_service`] object exists.
-[indexterm2 get_io_service..io_service::work]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the work.
+All I/O service implementations have [link boost_asio.reference.io_service__service `io_service::service`] as a public base class. Custom I/O services may be implemented by deriving from this class and then added to an [link boost_asio.reference.io_service `io_service`] using the facilities described above.
+[heading Requirements]
- boost::asio::io_service & get_io_service();
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:add_service io_service::add_service]
+[indexterm2 add_service..io_service]
+Add a service object to the [link boost_asio.reference.io_service `io_service`].
-[section:work io_service::work::work]
-[indexterm2 work..io_service::work]
-Constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
+ template<
+ typename ``[link boost_asio.reference.Service Service]``>
+ friend void add_service(
+ io_service & ios,
+ Service * svc);
- explicit ``[link boost_asio.reference.io_service__work.work.overload1 work]``(
- boost::asio::io_service & io_service);
- `` [''''»''' [link boost_asio.reference.io_service__work.work.overload1 more...]]``
+This function is used to add a service to the [link boost_asio.reference.io_service `io_service`].
-Copy constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
+[heading Parameters]
+
+[variablelist
+
+[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
- ``[link boost_asio.reference.io_service__work.work.overload2 work]``(
- const work & other);
- `` [''''»''' [link boost_asio.reference.io_service__work.work.overload2 more...]]``
+[[svc][The service object. On success, ownership of the service object is transferred to the [link boost_asio.reference.io_service `io_service`]. When the [link boost_asio.reference.io_service `io_service`] object is destroyed, it will destroy the service object by performing:
+``
+ delete static_cast<io_service::service*>(svc)
+``
+]]
+]
-[section:overload1 io_service::work::work (1 of 2 overloads)]
+[heading Exceptions]
+
-Constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
+[variablelist
+
+[[boost::asio::service_already_exists][Thrown if a service of the given type is already present in the [link boost_asio.reference.io_service `io_service`].]]
+[[boost::asio::invalid_service_owner][Thrown if the service's owning [link boost_asio.reference.io_service `io_service`] is not the [link boost_asio.reference.io_service `io_service`] object specified by the ios parameter. ]]
- work(
- boost::asio::io_service & io_service);
+]
-The constructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has begun. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while the work is underway.
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload2 io_service::work::work (2 of 2 overloads)]
+[endsect]
-Copy constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
+[section:dispatch io_service::dispatch]
- work(
- const work & other);
+[indexterm2 dispatch..io_service]
+Request the [link boost_asio.reference.io_service `io_service`] to invoke the given handler.
-The constructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has begun. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while the work is underway.
+ template<
+ typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
+ void dispatch(
+ CompletionHandler handler);
-[endsect]
+This function is used to ask the [link boost_asio.reference.io_service `io_service`] to execute the given handler.
+The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the `run()`, `run_one()`, `poll()` or `poll_one()` member functions is currently being invoked. The handler may be executed inside this function if the guarantee can be met.
-[endsect]
+[heading Parameters]
+
-[section:_work io_service::work::~work]
+[variablelist
+
+[[handler][The handler to be called. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler();
+``
+]]
-[indexterm2 ~work..io_service::work]
-Destructor notifies the [link boost_asio.reference.io_service `io_service`] that the work is complete.
+]
- ~work();
+[heading Remarks]
+
+This function throws an exception only if:
-The destructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has finished. Once the count of unfinished work reaches zero, the [link boost_asio.reference.io_service `io_service`] object's `run()` function is permitted to exit.
+* the handler's `asio_handler_allocate` function; or
-[endsect]
+* the handler's copy constructor
+throws an exception.
[endsect]
-[section:ip__address ip::address]
-
-
-Implements version-independent IP addresses.
- class address
+[section:fork_event io_service::fork_event]
+[indexterm2 fork_event..io_service]
+Fork-related event notifications.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__address.address [*address]]]
- [Default constructor.
+ enum fork_event
- Construct an address from an IPv4 address.
+[indexterm2 fork_prepare..io_service]
+[indexterm2 fork_parent..io_service]
+[indexterm2 fork_child..io_service]
- Construct an address from an IPv6 address.
+[heading Values]
+[variablelist
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.from_string [*from_string]]]
- [Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.is_loopback [*is_loopback]]]
- [Determine whether the address is a loopback address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.is_multicast [*is_multicast]]]
- [Determine whether the address is a multicast address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.is_unspecified [*is_unspecified]]]
- [Determine whether the address is unspecified. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.is_v4 [*is_v4]]]
- [Get whether the address is an IP version 4 address. ]
- ]
-
[
- [[link boost_asio.reference.ip__address.is_v6 [*is_v6]]]
- [Get whether the address is an IP version 6 address. ]
+ [fork_prepare]
+ [Notify the io_service that the process is about to fork. ]
]
-
- [
- [[link boost_asio.reference.ip__address.operator_eq_ [*operator=]]]
- [Assign from another address.
-
- Assign from an IPv4 address.
- Assign from an IPv6 address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.to_string [*to_string]]]
- [Get the address as a string in dotted decimal format. ]
- ]
-
[
- [[link boost_asio.reference.ip__address.to_v4 [*to_v4]]]
- [Get the address as an IP version 4 address. ]
+ [fork_parent]
+ [Notify the io_service that the process has forked and is the parent. ]
]
-
+
[
- [[link boost_asio.reference.ip__address.to_v6 [*to_v6]]]
- [Get the address as an IP version 6 address. ]
+ [fork_child]
+ [Notify the io_service that the process has forked and is the child. ]
]
-
+
]
-[heading Friends]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__address.operator_not__eq_ [*operator!=]]]
- [Compare two addresses for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.operator_lt_ [*operator<]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.operator_lt__eq_ [*operator<=]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.operator_eq__eq_ [*operator==]]]
- [Compare two addresses for equality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.operator_gt_ [*operator>]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address.operator_gt__eq_ [*operator>=]]]
- [Compare addresses for ordering. ]
- ]
-
-]
-[heading Related Functions]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.ip__address.operator_lt__lt_ [*operator<<]]]
- [Output an address as a string. ]
- ]
-
-]
-The [link boost_asio.reference.ip__address `ip::address`] class provides the ability to use either IP version 4 or version 6 addresses.
+[section:has_service io_service::has_service]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[indexterm2 has_service..io_service]
+Determine if an [link boost_asio.reference.io_service `io_service`] contains a specified service type.
-[*Shared] [*objects:] Unsafe.
+ template<
+ typename ``[link boost_asio.reference.Service Service]``>
+ friend bool has_service(
+ io_service & ios);
-[heading Requirements]
+This function is used to determine whether the [link boost_asio.reference.io_service `io_service`] contains a service object corresponding to the given service type.
-[*Header: ][^boost/asio/ip/address.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Parameters]
+
-[section:address ip::address::address]
+[variablelist
+
+[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
-[indexterm2 address..ip::address]
-Default constructor.
+]
- ``[link boost_asio.reference.ip__address.address.overload1 address]``();
- `` [''''»''' [link boost_asio.reference.ip__address.address.overload1 more...]]``
+[heading Return Value]
+
+A boolean indicating whether the [link boost_asio.reference.io_service `io_service`] contains the service.
-Construct an address from an IPv4 address.
+[heading Requirements]
- ``[link boost_asio.reference.ip__address.address.overload2 address]``(
- const boost::asio::ip::address_v4 & ipv4_address);
- `` [''''»''' [link boost_asio.reference.ip__address.address.overload2 more...]]``
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-Construct an address from an IPv6 address.
+[endsect]
- ``[link boost_asio.reference.ip__address.address.overload3 address]``(
- const boost::asio::ip::address_v6 & ipv6_address);
- `` [''''»''' [link boost_asio.reference.ip__address.address.overload3 more...]]``
+[section:io_service io_service::io_service]
-Copy constructor.
+[indexterm2 io_service..io_service]
+Constructor.
- ``[link boost_asio.reference.ip__address.address.overload4 address]``(
- const address & other);
- `` [''''»''' [link boost_asio.reference.ip__address.address.overload4 more...]]``
+ ``[link boost_asio.reference.io_service.io_service.overload1 io_service]``();
+ `` [''''»''' [link boost_asio.reference.io_service.io_service.overload1 more...]]``
+
+ explicit ``[link boost_asio.reference.io_service.io_service.overload2 io_service]``(
+ std::size_t concurrency_hint);
+ `` [''''»''' [link boost_asio.reference.io_service.io_service.overload2 more...]]``
-[section:overload1 ip::address::address (1 of 4 overloads)]
+[section:overload1 io_service::io_service (1 of 2 overloads)]
-Default constructor.
+Constructor.
- address();
+ io_service();
@@ -54790,204 +54836,224 @@
-[section:overload2 ip::address::address (2 of 4 overloads)]
-
+[section:overload2 io_service::io_service (2 of 2 overloads)]
-Construct an address from an IPv4 address.
+Constructor.
- address(
- const boost::asio::ip::address_v4 & ipv4_address);
+ io_service(
+ std::size_t concurrency_hint);
-[endsect]
+Construct with a hint about the required level of concurrency.
+[heading Parameters]
+
-[section:overload3 ip::address::address (3 of 4 overloads)]
+[variablelist
+
+[[concurrency_hint][A suggestion to the implementation on how many threads it should allow to run simultaneously. ]]
+]
-Construct an address from an IPv6 address.
- address(
- const boost::asio::ip::address_v6 & ipv6_address);
+[endsect]
[endsect]
+[section:notify_fork io_service::notify_fork]
-[section:overload4 ip::address::address (4 of 4 overloads)]
+[indexterm2 notify_fork..io_service]
+Notify the [link boost_asio.reference.io_service `io_service`] of a fork-related event.
-Copy constructor.
+ void notify_fork(
+ boost::asio::io_service::fork_event event);
- address(
- const address & other);
+This function is used to inform the [link boost_asio.reference.io_service `io_service`] that the process is about to fork, or has just forked. This allows the [link boost_asio.reference.io_service `io_service`], and the services it contains, to perform any necessary housekeeping to ensure correct operation following a fork.
+This function must not be called while any other [link boost_asio.reference.io_service `io_service`] function, or any function on an I/O object associated with the [link boost_asio.reference.io_service `io_service`], is being called in another thread. It is, however, safe to call this function from within a completion handler, provided no other thread is accessing the [link boost_asio.reference.io_service `io_service`].
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[event][A fork-related event.]]
-[endsect]
+]
-[section:from_string ip::address::from_string]
-[indexterm2 from_string..ip::address]
-Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the notification fails the [link boost_asio.reference.io_service `io_service`] object should no longer be used and should be destroyed.]]
- static address ``[link boost_asio.reference.ip__address.from_string.overload1 from_string]``(
- const char * str);
- `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload1 more...]]``
+]
- static address ``[link boost_asio.reference.ip__address.from_string.overload2 from_string]``(
- const char * str,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload2 more...]]``
- static address ``[link boost_asio.reference.ip__address.from_string.overload3 from_string]``(
- const std::string & str);
- `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload3 more...]]``
+[heading Example]
+
+The following code illustrates how to incorporate the `notify_fork()` function:
- static address ``[link boost_asio.reference.ip__address.from_string.overload4 from_string]``(
- const std::string & str,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload4 more...]]``
+ my_io_service.notify_fork(boost::asio::io_service::fork_prepare);
+ if (fork() == 0)
+ {
+ // This is the child process.
+ my_io_service.notify_fork(boost::asio::io_service::fork_child);
+ }
+ else
+ {
+ // This is the parent process.
+ my_io_service.notify_fork(boost::asio::io_service::fork_parent);
+ }
-[section:overload1 ip::address::from_string (1 of 4 overloads)]
-Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
+[heading Remarks]
+
+For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, performs `svc->fork_service();`. When processing the fork\_prepare event, services are visited in reverse order of the beginning of service object lifetime. Otherwise, services are visited in order of the beginning of service object lifetime.
- static address from_string(
- const char * str);
[endsect]
+[section:poll io_service::poll]
-[section:overload2 ip::address::from_string (2 of 4 overloads)]
-
+[indexterm2 poll..io_service]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
-Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
+ std::size_t ``[link boost_asio.reference.io_service.poll.overload1 poll]``();
+ `` [''''»''' [link boost_asio.reference.io_service.poll.overload1 more...]]``
- static address from_string(
- const char * str,
+ std::size_t ``[link boost_asio.reference.io_service.poll.overload2 poll]``(
boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.io_service.poll.overload2 more...]]``
+[section:overload1 io_service::poll (1 of 2 overloads)]
-[endsect]
-
-
-
-[section:overload3 ip::address::from_string (3 of 4 overloads)]
-
-
-Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
- static address from_string(
- const std::string & str);
+ std::size_t poll();
-[endsect]
+The `poll()` function runs handlers that are ready to run, without blocking, until the [link boost_asio.reference.io_service `io_service`] has been stopped or there are no more ready handlers.
+[heading Return Value]
+
+The number of handlers that were executed.
-[section:overload4 ip::address::from_string (4 of 4 overloads)]
+[heading Exceptions]
+
-Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
- static address from_string(
- const std::string & str,
- boost::system::error_code & ec);
[endsect]
-[endsect]
+[section:overload2 io_service::poll (2 of 2 overloads)]
-[section:is_loopback ip::address::is_loopback]
-[indexterm2 is_loopback..ip::address]
-Determine whether the address is a loopback address.
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute ready handlers.
- bool is_loopback() const;
+ std::size_t poll(
+ boost::system::error_code & ec);
+The `poll()` function runs handlers that are ready to run, without blocking, until the [link boost_asio.reference.io_service `io_service`] has been stopped or there are no more ready handlers.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
-[section:is_multicast ip::address::is_multicast]
+]
-[indexterm2 is_multicast..ip::address]
-Determine whether the address is a multicast address.
+[heading Return Value]
+
+The number of handlers that were executed.
- bool is_multicast() const;
[endsect]
+[endsect]
-[section:is_unspecified ip::address::is_unspecified]
-
-[indexterm2 is_unspecified..ip::address]
-Determine whether the address is unspecified.
-
+[section:poll_one io_service::poll_one]
- bool is_unspecified() const;
+[indexterm2 poll_one..io_service]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
+ std::size_t ``[link boost_asio.reference.io_service.poll_one.overload1 poll_one]``();
+ `` [''''»''' [link boost_asio.reference.io_service.poll_one.overload1 more...]]``
-[endsect]
+ std::size_t ``[link boost_asio.reference.io_service.poll_one.overload2 poll_one]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.io_service.poll_one.overload2 more...]]``
+[section:overload1 io_service::poll_one (1 of 2 overloads)]
-[section:is_v4 ip::address::is_v4]
-[indexterm2 is_v4..ip::address]
-Get whether the address is an IP version 4 address.
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
- bool is_v4() const;
+ std::size_t poll_one();
+The `poll_one()` function runs at most one handler that is ready to run, without blocking.
-[endsect]
+[heading Return Value]
+
+The number of handlers that were executed.
-[section:is_v6 ip::address::is_v6]
+[heading Exceptions]
+
-[indexterm2 is_v6..ip::address]
-Get whether the address is an IP version 6 address.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
- bool is_v6() const;
@@ -54995,65 +55061,57 @@
-[section:operator_not__eq_ ip::address::operator!=]
-
-[indexterm2 operator!=..ip::address]
-Compare two addresses for inequality.
-
-
- friend bool operator!=(
- const address & a1,
- const address & a2);
+[section:overload2 io_service::poll_one (2 of 2 overloads)]
-[heading Requirements]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute one ready handler.
-[*Header: ][^boost/asio/ip/address.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ std::size_t poll_one(
+ boost::system::error_code & ec);
-[endsect]
+The `poll_one()` function runs at most one handler that is ready to run, without blocking.
+[heading Parameters]
+
-[section:operator_lt_ ip::address::operator<]
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
-[indexterm2 operator<..ip::address]
-Compare addresses for ordering.
+]
- friend bool operator<(
- const address & a1,
- const address & a2);
+[heading Return Value]
+
+The number of handlers that were executed.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:post io_service::post]
-[section:operator_lt__lt_ ip::address::operator<<]
-
-[indexterm2 operator<<..ip::address]
-Output an address as a string.
+[indexterm2 post..io_service]
+Request the [link boost_asio.reference.io_service `io_service`] to invoke the given handler and return immediately.
template<
- typename Elem,
- typename Traits>
- std::basic_ostream< Elem, Traits > & operator<<(
- std::basic_ostream< Elem, Traits > & os,
- const address & addr);
+ typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
+ void post(
+ CompletionHandler handler);
-Used to output a human-readable string for a specified address.
+This function is used to ask the [link boost_asio.reference.io_service `io_service`] to execute the given handler, but without allowing the [link boost_asio.reference.io_service `io_service`] to call the handler from inside this function.
+
+The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the `run()`, `run_one()`, `poll()` or `poll_one()` member functions is currently being invoked.
[heading Parameters]
@@ -55061,250 +55119,256 @@
[variablelist
-[[os][The output stream to which the string will be written.]]
-
-[[addr][The address to be written.]]
+[[handler][The handler to be called. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler();
+``
+]]
]
-[heading Return Value]
+[heading Remarks]
-The output stream.
+This function throws an exception only if:
+* the handler's `asio_handler_allocate` function; or
-[endsect]
+* the handler's copy constructor
+throws an exception.
-[section:operator_lt__eq_ ip::address::operator<=]
+[endsect]
-[indexterm2 operator<=..ip::address]
-Compare addresses for ordering.
- friend bool operator<=(
- const address & a1,
- const address & a2);
+[section:reset io_service::reset]
+[indexterm2 reset..io_service]
+Reset the [link boost_asio.reference.io_service `io_service`] in preparation for a subsequent `run()` invocation.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address.hpp]
+ void reset();
-[*Convenience header: ][^boost/asio.hpp]
+This function must be called prior to any second or later set of invocations of the `run()`, `run_one()`, `poll()` or `poll_one()` functions when a previous invocation of these functions returned due to the [link boost_asio.reference.io_service `io_service`] being stopped or running out of work. After a call to `reset()`, the [link boost_asio.reference.io_service `io_service`] object's `stopped()` function will return `false`.
-[endsect]
+This function must not be called while there are any unfinished calls to the `run()`, `run_one()`, `poll()` or `poll_one()` functions.
-[section:operator_eq_ ip::address::operator=]
+[endsect]
-[indexterm2 operator=..ip::address]
-Assign from another address.
+[section:run io_service::run]
- address & ``[link boost_asio.reference.ip__address.operator_eq_.overload1 operator=]``(
- const address & other);
- `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload1 more...]]``
+[indexterm2 run..io_service]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
-Assign from an IPv4 address.
+ std::size_t ``[link boost_asio.reference.io_service.run.overload1 run]``();
+ `` [''''»''' [link boost_asio.reference.io_service.run.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.io_service.run.overload2 run]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.io_service.run.overload2 more...]]``
- address & ``[link boost_asio.reference.ip__address.operator_eq_.overload2 operator=]``(
- const boost::asio::ip::address_v4 & ipv4_address);
- `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload2 more...]]``
+[section:overload1 io_service::run (1 of 2 overloads)]
-Assign from an IPv6 address.
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
- address & ``[link boost_asio.reference.ip__address.operator_eq_.overload3 operator=]``(
- const boost::asio::ip::address_v6 & ipv6_address);
- `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload3 more...]]``
+ std::size_t run();
-[section:overload1 ip::address::operator= (1 of 3 overloads)]
+The `run()` function blocks until all work has finished and there are no more handlers to be dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
-Assign from another address.
-
-
- address & operator=(
- const address & other);
-
+Multiple threads may call the `run()` function to set up a pool of threads from which the [link boost_asio.reference.io_service `io_service`] may execute handlers. All threads that are waiting in the pool are equivalent and the [link boost_asio.reference.io_service `io_service`] may choose any one of them to invoke a handler.
+A normal exit from the `run()` function implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
-[endsect]
+[heading Return Value]
+
+The number of handlers that were executed.
-[section:overload2 ip::address::operator= (2 of 3 overloads)]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-Assign from an IPv4 address.
+]
- address & operator=(
- const boost::asio::ip::address_v4 & ipv4_address);
+[heading Remarks]
+
+The `run()` function must not be called from a thread that is currently calling one of `run()`, `run_one()`, `poll()` or `poll_one()` on the same [link boost_asio.reference.io_service `io_service`] object.
+The `poll()` function may also be used to dispatch ready handlers, but without blocking.
[endsect]
-[section:overload3 ip::address::operator= (3 of 3 overloads)]
-
+[section:overload2 io_service::run (2 of 2 overloads)]
-Assign from an IPv6 address.
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
- address & operator=(
- const boost::asio::ip::address_v6 & ipv6_address);
+ std::size_t run(
+ boost::system::error_code & ec);
-[endsect]
+The `run()` function blocks until all work has finished and there are no more handlers to be dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
+Multiple threads may call the `run()` function to set up a pool of threads from which the [link boost_asio.reference.io_service `io_service`] may execute handlers. All threads that are waiting in the pool are equivalent and the [link boost_asio.reference.io_service `io_service`] may choose any one of them to invoke a handler.
-[endsect]
+A normal exit from the `run()` function implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
-[section:operator_eq__eq_ ip::address::operator==]
+[heading Parameters]
+
-[indexterm2 operator==..ip::address]
-Compare two addresses for equality.
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
+]
- friend bool operator==(
- const address & a1,
- const address & a2);
+[heading Return Value]
+
+The number of handlers that were executed.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address.hpp]
+[heading Remarks]
+
+The `run()` function must not be called from a thread that is currently calling one of `run()`, `run_one()`, `poll()` or `poll_one()` on the same [link boost_asio.reference.io_service `io_service`] object.
-[*Convenience header: ][^boost/asio.hpp]
+The `poll()` function may also be used to dispatch ready handlers, but without blocking.
[endsect]
+[endsect]
-[section:operator_gt_ ip::address::operator>]
+[section:run_one io_service::run_one]
-[indexterm2 operator>..ip::address]
-Compare addresses for ordering.
+[indexterm2 run_one..io_service]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
- friend bool operator>(
- const address & a1,
- const address & a2);
+ std::size_t ``[link boost_asio.reference.io_service.run_one.overload1 run_one]``();
+ `` [''''»''' [link boost_asio.reference.io_service.run_one.overload1 more...]]``
+ std::size_t ``[link boost_asio.reference.io_service.run_one.overload2 run_one]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.io_service.run_one.overload2 more...]]``
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address.hpp]
+[section:overload1 io_service::run_one (1 of 2 overloads)]
-[*Convenience header: ][^boost/asio.hpp]
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
-[endsect]
+ std::size_t run_one();
-[section:operator_gt__eq_ ip::address::operator>=]
+The `run_one()` function blocks until one handler has been dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
-[indexterm2 operator>=..ip::address]
-Compare addresses for ordering.
+[heading Return Value]
+
+The number of handlers that were executed. A zero return value implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
- friend bool operator>=(
- const address & a1,
- const address & a2);
+[heading Exceptions]
+
-[heading Requirements]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+
+]
-[*Header: ][^boost/asio/ip/address.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:to_string ip::address::to_string]
-[indexterm2 to_string..ip::address]
-Get the address as a string in dotted decimal format.
+[section:overload2 io_service::run_one (2 of 2 overloads)]
- std::string ``[link boost_asio.reference.ip__address.to_string.overload1 to_string]``() const;
- `` [''''»''' [link boost_asio.reference.ip__address.to_string.overload1 more...]]``
+Run the [link boost_asio.reference.io_service `io_service`] object's event processing loop to execute at most one handler.
- std::string ``[link boost_asio.reference.ip__address.to_string.overload2 to_string]``(
- boost::system::error_code & ec) const;
- `` [''''»''' [link boost_asio.reference.ip__address.to_string.overload2 more...]]``
+ std::size_t run_one(
+ boost::system::error_code & ec);
-[section:overload1 ip::address::to_string (1 of 2 overloads)]
+
+The `run_one()` function blocks until one handler has been dispatched, or until the [link boost_asio.reference.io_service `io_service`] has been stopped.
-Get the address as a string in dotted decimal format.
+[heading Return Value]
+
+The number of handlers that were executed. A zero return value implies that the [link boost_asio.reference.io_service `io_service`] object is stopped (the `stopped()` function returns `true`). Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately unless there is a prior call to `reset()`.
+The number of handlers that were executed.
- std::string to_string() const;
[endsect]
-
-[section:overload2 ip::address::to_string (2 of 2 overloads)]
+[endsect]
-Get the address as a string in dotted decimal format.
+[section:stop io_service::stop]
+[indexterm2 stop..io_service]
+Stop the [link boost_asio.reference.io_service `io_service`] object's event processing loop.
- std::string to_string(
- boost::system::error_code & ec) const;
+ void stop();
-[endsect]
+This function does not block, but instead simply signals the [link boost_asio.reference.io_service `io_service`] to stop. All invocations of its `run()` or `run_one()` member functions should return as soon as possible. Subsequent calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately until `reset()` is called.
[endsect]
-[section:to_v4 ip::address::to_v4]
-
-[indexterm2 to_v4..ip::address]
-Get the address as an IP version 4 address.
-
-
- boost::asio::ip::address_v4 to_v4() const;
+[section:stopped io_service::stopped]
+[indexterm2 stopped..io_service]
+Determine whether the [link boost_asio.reference.io_service `io_service`] object has been stopped.
-[endsect]
+ bool stopped() const;
-[section:to_v6 ip::address::to_v6]
+This function is used to determine whether an [link boost_asio.reference.io_service `io_service`] object has been stopped, either through an explicit call to `stop()`, or due to running out of work. When an [link boost_asio.reference.io_service `io_service`] object is stopped, calls to `run()`, `run_one()`, `poll()` or `poll_one()` will return immediately without invoking any handlers.
-[indexterm2 to_v6..ip::address]
-Get the address as an IP version 6 address.
+[heading Return Value]
+
+`true` if the [link boost_asio.reference.io_service `io_service`] object is stopped, otherwise `false`.
- boost::asio::ip::address_v6 to_v6() const;
@@ -55312,259 +55376,139 @@
-[endsect]
-
-[section:ip__address_v4 ip::address_v4]
+[section:use_service io_service::use_service]
+[indexterm2 use_service..io_service]
+Obtain the service object corresponding to the given type.
-Implements IP version 4 style addresses.
+ template<
+ typename ``[link boost_asio.reference.Service Service]``>
+ friend Service & use_service(
+ io_service & ios);
- class address_v4
+This function is used to locate a service object that corresponds to the given service type. If there is no existing implementation of the service, then the [link boost_asio.reference.io_service `io_service`] will create a new instance of the service.
-[heading Types]
-[table
- [[Name][Description]]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.ip__address_v4.bytes_type [*bytes_type]]]
- [The type used to represent an address as an array of bytes. ]
+[variablelist
- ]
+[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__address_v4.address_v4 [*address_v4]]]
- [Default constructor.
+[heading Return Value]
+
+The service interface implementing the specified service type. Ownership of the service interface is not transferred to the caller.
- Construct an address from raw bytes.
- Construct an address from a unsigned long in host byte order.
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.any [*any]]]
- [Obtain an address object that represents any address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.broadcast [*broadcast]]]
- [Obtain an address object that represents the broadcast address.
+[heading Requirements]
- Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.from_string [*from_string]]]
- [Create an address from an IP address string in dotted decimal form. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_class_a [*is_class_a]]]
- [Determine whether the address is a class A address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_class_b [*is_class_b]]]
- [Determine whether the address is a class B address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_class_c [*is_class_c]]]
- [Determine whether the address is a class C address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_loopback [*is_loopback]]]
- [Determine whether the address is a loopback address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_multicast [*is_multicast]]]
- [Determine whether the address is a multicast address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.is_unspecified [*is_unspecified]]]
- [Determine whether the address is unspecified. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.loopback [*loopback]]]
- [Obtain an address object that represents the loopback address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.netmask [*netmask]]]
- [Obtain the netmask that corresponds to the address, based on its address class. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_eq_ [*operator=]]]
- [Assign from another address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.to_bytes [*to_bytes]]]
- [Get the address in bytes, in network byte order. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.to_string [*to_string]]]
- [Get the address as a string in dotted decimal format. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.to_ulong [*to_ulong]]]
- [Get the address as an unsigned long in host byte order. ]
- ]
-
-]
+[*Header: ][^boost/asio/io_service.hpp]
-[heading Friends]
-[table
- [[Name][Description]]
+[*Convenience header: ][^boost/asio.hpp]
- [
- [[link boost_asio.reference.ip__address_v4.operator_not__eq_ [*operator!=]]]
- [Compare two addresses for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_lt_ [*operator<]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_lt__eq_ [*operator<=]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_eq__eq_ [*operator==]]]
- [Compare two addresses for equality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_gt_ [*operator>]]]
- [Compare addresses for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v4.operator_gt__eq_ [*operator>=]]]
- [Compare addresses for ordering. ]
- ]
-
-]
-[heading Related Functions]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.ip__address_v4.operator_lt__lt_ [*operator<<]]]
- [Output an address as a string. ]
- ]
-
-]
-The [link boost_asio.reference.ip__address_v4 `ip::address_v4`] class provides the ability to use and manipulate IP version 4 addresses.
+[section:wrap io_service::wrap]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[indexterm2 wrap..io_service]
+Create a new handler that automatically dispatches the wrapped handler on the [link boost_asio.reference.io_service `io_service`].
-[*Shared] [*objects:] Unsafe.
+ template<
+ typename ``[link boost_asio.reference.Handler Handler]``>
+ unspecified wrap(
+ Handler handler);
-[heading Requirements]
+This function is used to create a new handler function object that, when invoked, will automatically pass the wrapped handler to the [link boost_asio.reference.io_service `io_service`] object's dispatch function.
-[*Header: ][^boost/asio/ip/address_v4.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Parameters]
+
-[section:address_v4 ip::address_v4::address_v4]
+[variablelist
+
+[[handler][The handler to be wrapped. The [link boost_asio.reference.io_service `io_service`] will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler(A1 a1, ... An an);
+``
+]]
-[indexterm2 address_v4..ip::address_v4]
-Default constructor.
+]
- ``[link boost_asio.reference.ip__address_v4.address_v4.overload1 address_v4]``();
- `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload1 more...]]``
+[heading Return Value]
+
+A function object that, when invoked, passes the wrapped handler to the [link boost_asio.reference.io_service `io_service`] object's dispatch function. Given a function object with the signature:
+ R f(A1 a1, ... An an);
-Construct an address from raw bytes.
+If this function object is passed to the wrap function like so:
- explicit ``[link boost_asio.reference.ip__address_v4.address_v4.overload2 address_v4]``(
- const bytes_type & bytes);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload2 more...]]``
+ io_service.wrap(f);
-Construct an address from a unsigned long in host byte order.
+then the return value is a function object with the signature
+ void g(A1 a1, ... An an);
- explicit ``[link boost_asio.reference.ip__address_v4.address_v4.overload3 address_v4]``(
- unsigned long addr);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload3 more...]]``
+that, when invoked, executes code equivalent to:
-Copy constructor.
+ io_service.dispatch(boost::bind(f, a1, ... an));
- ``[link boost_asio.reference.ip__address_v4.address_v4.overload4 address_v4]``(
- const address_v4 & other);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload4 more...]]``
-[section:overload1 ip::address_v4::address_v4 (1 of 4 overloads)]
-Default constructor.
+[endsect]
- address_v4();
+[section:_io_service io_service::~io_service]
-[endsect]
+[indexterm2 ~io_service..io_service]
+Destructor.
+ ~io_service();
-[section:overload2 ip::address_v4::address_v4 (2 of 4 overloads)]
+On destruction, the [link boost_asio.reference.io_service `io_service`] performs the following sequence of operations:
-Construct an address from raw bytes.
+* For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, in reverse order of the beginning of service object lifetime, performs `svc->shutdown_service()`.
- address_v4(
- const bytes_type & bytes);
+* Uninvoked handler objects that were scheduled for deferred invocation on the [link boost_asio.reference.io_service `io_service`], or any associated strand, are destroyed.
-[endsect]
+* For each service object `svc` in the [link boost_asio.reference.io_service `io_service`] set, in reverse order of the beginning of service object lifetime, performs `delete static_cast<io_service::service*>(svc)`.
+[heading Remarks]
+
+The destruction sequence described above permits programs to simplify their resource management by using `shared_ptr<>`. Where an object's lifetime is tied to the lifetime of a connection (or some other sequence of asynchronous operations), a `shared_ptr` to the object would be bound into the handlers for all asynchronous operations associated with it. This works as follows:
-[section:overload3 ip::address_v4::address_v4 (3 of 4 overloads)]
+* When a single connection ends, all associated asynchronous operations complete. The corresponding handler objects are destroyed, and all `shared_ptr` references to the objects are destroyed.
-Construct an address from a unsigned long in host byte order.
+* To shut down the whole program, the [link boost_asio.reference.io_service `io_service`] function `stop()` is called to terminate any `run()` calls as soon as possible. The [link boost_asio.reference.io_service `io_service`] destructor defined above destroys all handlers, causing all `shared_ptr` references to all connection objects to be destroyed.
- address_v4(
- unsigned long addr);
@@ -55572,163 +55516,191 @@
-[section:overload4 ip::address_v4::address_v4 (4 of 4 overloads)]
+[endsect]
+[section:io_service__id io_service::id]
-Copy constructor.
+Class used to uniquely identify a service.
- address_v4(
- const address_v4 & other);
+ class id :
+ noncopyable
-[endsect]
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.io_service__id.id [*id]]]
+ [Constructor. ]
+ ]
+
+]
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/io_service.hpp]
-[section:any ip::address_v4::any]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 any..ip::address_v4]
-Obtain an address object that represents any address.
+[section:id io_service::id::id]
- static address_v4 any();
+[indexterm2 id..io_service::id]
+Constructor.
+ id();
-[endsect]
-[section:broadcast ip::address_v4::broadcast]
+[endsect]
-[indexterm2 broadcast..ip::address_v4]
-Obtain an address object that represents the broadcast address.
- static address_v4 ``[link boost_asio.reference.ip__address_v4.broadcast.overload1 broadcast]``();
- `` [''''»''' [link boost_asio.reference.ip__address_v4.broadcast.overload1 more...]]``
+[endsect]
+[section:io_service__service io_service::service]
-Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask.
+Base class for all [link boost_asio.reference.io_service `io_service`] services.
- static address_v4 ``[link boost_asio.reference.ip__address_v4.broadcast.overload2 broadcast]``(
- const address_v4 & addr,
- const address_v4 & mask);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.broadcast.overload2 more...]]``
+ class service :
+ noncopyable
-[section:overload1 ip::address_v4::broadcast (1 of 2 overloads)]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-Obtain an address object that represents the broadcast address.
+ [
+ [[link boost_asio.reference.io_service__service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
- static address_v4 broadcast();
+ [
+ [[link boost_asio.reference.io_service__service.service [*service]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__service._service [*~service]]]
+ [Destructor. ]
+ ]
+
+]
+[heading Private Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.io_service__service.fork_service [*fork_service]]]
+ [Handle notification of a fork-related event to perform any necessary housekeeping. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__service.shutdown_service [*shutdown_service]]]
+ [Destroy all user-defined handler objects owned by the service. ]
+ ]
+
+]
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload2 ip::address_v4::broadcast (2 of 2 overloads)]
+[section:get_io_service io_service::service::get_io_service]
-Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask.
+[indexterm2 get_io_service..io_service::service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
- static address_v4 broadcast(
- const address_v4 & addr,
- const address_v4 & mask);
+ boost::asio::io_service & get_io_service();
[endsect]
-[endsect]
-
-[section:bytes_type ip::address_v4::bytes_type]
+[section:service io_service::service::service]
-[indexterm2 bytes_type..ip::address_v4]
-The type used to represent an address as an array of bytes.
+[indexterm2 service..io_service::service]
+Constructor.
- typedef array< unsigned char, 4 > bytes_type;
+ service(
+ boost::asio::io_service & owner);
+[heading Parameters]
+
-[heading Remarks]
-
-This type is defined in terms of the C++0x template `std::array` when it is available. Otherwise, it uses `boost:array`.
+[variablelist
+
+[[owner][The [link boost_asio.reference.io_service `io_service`] object that owns the service. ]]
+]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[endsect]
+[section:_service io_service::service::~service]
-[section:from_string ip::address_v4::from_string]
+[indexterm2 ~service..io_service::service]
+Destructor.
-[indexterm2 from_string..ip::address_v4]
-Create an address from an IP address string in dotted decimal form.
+ virtual ~service();
- static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload1 from_string]``(
- const char * str);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload1 more...]]``
- static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload2 from_string]``(
- const char * str,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload2 more...]]``
- static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload3 from_string]``(
- const std::string & str);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload3 more...]]``
+[endsect]
- static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload4 from_string]``(
- const std::string & str,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload4 more...]]``
-[section:overload1 ip::address_v4::from_string (1 of 4 overloads)]
+[section:fork_service io_service::service::fork_service]
+[indexterm2 fork_service..io_service::service]
+Handle notification of a fork-related event to perform any necessary housekeeping.
-Create an address from an IP address string in dotted decimal form.
+ virtual void fork_service(
+ boost::asio::io_service::fork_event event);
- static address_v4 from_string(
- const char * str);
+This function is not a pure virtual so that services only have to implement it if necessary. The default implementation does nothing.
[endsect]
-[section:overload2 ip::address_v4::from_string (2 of 4 overloads)]
-
+[section:shutdown_service io_service::service::shutdown_service]
-Create an address from an IP address string in dotted decimal form.
+[indexterm2 shutdown_service..io_service::service]
+Destroy all user-defined handler objects owned by the service.
- static address_v4 from_string(
- const char * str,
- boost::system::error_code & ec);
+ void shutdown_service();
@@ -55736,102 +55708,148 @@
-[section:overload3 ip::address_v4::from_string (3 of 4 overloads)]
-
-
-Create an address from an IP address string in dotted decimal form.
+[endsect]
+[section:io_service__strand io_service::strand]
- static address_v4 from_string(
- const std::string & str);
+Provides serialised handler execution.
-[endsect]
+ class strand
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[section:overload4 ip::address_v4::from_string (4 of 4 overloads)]
+ [
+ [[link boost_asio.reference.io_service__strand.dispatch [*dispatch]]]
+ [Request the strand to invoke the given handler. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the strand. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.post [*post]]]
+ [Request the strand to invoke the given handler and return immediately. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.strand [*strand]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.wrap [*wrap]]]
+ [Create a new handler that automatically dispatches the wrapped handler on the strand. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand._strand [*~strand]]]
+ [Destructor. ]
+ ]
+
+]
+The [link boost_asio.reference.io_service__strand `io_service::strand`] class provides the ability to post and dispatch handlers with the guarantee that none of those handlers will execute concurrently.
-Create an address from an IP address string in dotted decimal form.
+[heading Order of handler invocation]
+
+Given:
- static address_v4 from_string(
- const std::string & str,
- boost::system::error_code & ec);
+* a strand object `s`
-[endsect]
+* an object `a` meeting completion handler requirements
-[endsect]
+* an object `a1` which is an arbitrary copy of `a` made by the implementation
-[section:is_class_a ip::address_v4::is_class_a]
+* an object `b` meeting completion handler requirements
-[indexterm2 is_class_a..ip::address_v4]
-Determine whether the address is a class A address.
+* an object `b1` which is an arbitrary copy of `b` made by the implementation
- bool is_class_a() const;
+if any of the following conditions are true:
+* `s.post(a)` happens-before `s.post(b)`
-[endsect]
+* `s.post(a)` happens-before `s.dispatch(b)`, where the latter is performed outside the strand
-[section:is_class_b ip::address_v4::is_class_b]
+* `s.dispatch(a)` happens-before `s.post(b)`, where the former is performed outside the strand
-[indexterm2 is_class_b..ip::address_v4]
-Determine whether the address is a class B address.
+* `s.dispatch(a)` happens-before `s.dispatch(b)`, where both are performed outside the strand
- bool is_class_b() const;
+then `asio_handler_invoke(a1, &a1)` happens-before `asio_handler_invoke(b1, &b1)`.
+Note that in the following case:
+ async_op_1(..., s.wrap(a));
+ async_op_2(..., s.wrap(b));
-[endsect]
+the completion of the first async operation will perform `s.dispatch(a)`, and the second will perform `s.dispatch(b)`, but the order in which those are performed is unspecified. That is, you cannot state whether one happens-before the other. Therefore none of the above conditions are met and no ordering guarantee is made.
-[section:is_class_c ip::address_v4::is_class_c]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[indexterm2 is_class_c..ip::address_v4]
-Determine whether the address is a class C address.
+[*Shared] [*objects:] Safe.
- bool is_class_c() const;
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/strand.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:is_loopback ip::address_v4::is_loopback]
+[section:dispatch io_service::strand::dispatch]
-[indexterm2 is_loopback..ip::address_v4]
-Determine whether the address is a loopback address.
+[indexterm2 dispatch..io_service::strand]
+Request the strand to invoke the given handler.
- bool is_loopback() const;
+ template<
+ typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
+ void dispatch(
+ CompletionHandler handler);
+This function is used to ask the strand to execute the given handler.
-[endsect]
+The strand object guarantees that handlers posted or dispatched through the strand will not be executed concurrently. The handler may be executed inside this function if the guarantee can be met. If this function is called from within a handler that was posted or dispatched through the same strand, then the new handler will be executed immediately.
+The strand's guarantee is in addition to the guarantee provided by the underlying [link boost_asio.reference.io_service `io_service`]. The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the io\_service's run member function is currently being invoked.
-[section:is_multicast ip::address_v4::is_multicast]
+[heading Parameters]
+
-[indexterm2 is_multicast..ip::address_v4]
-Determine whether the address is a multicast address.
+[variablelist
+
+[[handler][The handler to be called. The strand will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler();
+``
+]]
+]
- bool is_multicast() const;
@@ -55839,27 +55857,22 @@
-[section:is_unspecified ip::address_v4::is_unspecified]
-
-[indexterm2 is_unspecified..ip::address_v4]
-Determine whether the address is unspecified.
-
-
- bool is_unspecified() const;
-
+[section:get_io_service io_service::strand::get_io_service]
+[indexterm2 get_io_service..io_service::strand]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the strand.
-[endsect]
+ boost::asio::io_service & get_io_service();
-[section:loopback ip::address_v4::loopback]
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the strand uses to dispatch handlers for asynchronous operations.
-[indexterm2 loopback..ip::address_v4]
-Obtain an address object that represents the loopback address.
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that the strand will use to dispatch handlers. Ownership is not transferred to the caller.
- static address_v4 loopback();
@@ -55867,80 +55880,85 @@
-[section:netmask ip::address_v4::netmask]
+[section:post io_service::strand::post]
-[indexterm2 netmask..ip::address_v4]
-Obtain the netmask that corresponds to the address, based on its address class.
+[indexterm2 post..io_service::strand]
+Request the strand to invoke the given handler and return immediately.
- static address_v4 netmask(
- const address_v4 & addr);
+ template<
+ typename ``[link boost_asio.reference.CompletionHandler CompletionHandler]``>
+ void post(
+ CompletionHandler handler);
+This function is used to ask the strand to execute the given handler, but without allowing the strand to call the handler from inside this function.
-[endsect]
+The strand object guarantees that handlers posted or dispatched through the strand will not be executed concurrently. The strand's guarantee is in addition to the guarantee provided by the underlying [link boost_asio.reference.io_service `io_service`]. The [link boost_asio.reference.io_service `io_service`] guarantees that the handler will only be called in a thread in which the io\_service's run member function is currently being invoked.
+[heading Parameters]
+
-[section:operator_not__eq_ ip::address_v4::operator!=]
+[variablelist
+
+[[handler][The handler to be called. The strand will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler();
+``
+]]
-[indexterm2 operator!=..ip::address_v4]
-Compare two addresses for inequality.
+]
- friend bool operator!=(
- const address_v4 & a1,
- const address_v4 & a2);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:strand io_service::strand::strand]
-[endsect]
+[indexterm2 strand..io_service::strand]
+Constructor.
+ strand(
+ boost::asio::io_service & io_service);
-[section:operator_lt_ ip::address_v4::operator<]
-[indexterm2 operator<..ip::address_v4]
-Compare addresses for ordering.
+Constructs the strand.
- friend bool operator<(
- const address_v4 & a1,
- const address_v4 & a2);
+[heading Parameters]
+
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the strand will use to dispatch handlers that are ready to be run. ]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:operator_lt__lt_ ip::address_v4::operator<<]
+[section:wrap io_service::strand::wrap]
-[indexterm2 operator<<..ip::address_v4]
-Output an address as a string.
+[indexterm2 wrap..io_service::strand]
+Create a new handler that automatically dispatches the wrapped handler on the strand.
template<
- typename Elem,
- typename Traits>
- std::basic_ostream< Elem, Traits > & operator<<(
- std::basic_ostream< Elem, Traits > & os,
- const address_v4 & addr);
+ typename ``[link boost_asio.reference.Handler Handler]``>
+ unspecified wrap(
+ Handler handler);
-Used to output a human-readable string for a specified address.
+This function is used to create a new handler function object that, when invoked, will automatically pass the wrapped handler to the strand's dispatch function.
[heading Parameters]
@@ -55948,54 +55966,39 @@
[variablelist
-[[os][The output stream to which the string will be written.]]
-
-[[addr][The address to be written.]]
+[[handler][The handler to be wrapped. The strand will make a copy of the handler object as required. The function signature of the handler must be:
+``
+ void handler(A1 a1, ... An an);
+``
+]]
]
[heading Return Value]
-The output stream.
-
-
-
-
-[endsect]
-
-
-
-[section:operator_lt__eq_ ip::address_v4::operator<=]
-
-[indexterm2 operator<=..ip::address_v4]
-Compare addresses for ordering.
+A function object that, when invoked, passes the wrapped handler to the strand's dispatch function. Given a function object with the signature:
+ R f(A1 a1, ... An an);
- friend bool operator<=(
- const address_v4 & a1,
- const address_v4 & a2);
+If this function object is passed to the wrap function like so:
-[heading Requirements]
+ strand.wrap(f);
-[*Header: ][^boost/asio/ip/address_v4.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+then the return value is a function object with the signature
+ void g(A1 a1, ... An an);
-[endsect]
+that, when invoked, executes code equivalent to:
+ strand.dispatch(boost::bind(f, a1, ... an));
-[section:operator_eq_ ip::address_v4::operator=]
-[indexterm2 operator=..ip::address_v4]
-Assign from another address.
- address_v4 & operator=(
- const address_v4 & other);
@@ -56003,324 +56006,266 @@
-[section:operator_eq__eq_ ip::address_v4::operator==]
-
-[indexterm2 operator==..ip::address_v4]
-Compare two addresses for equality.
+[section:_strand io_service::strand::~strand]
+[indexterm2 ~strand..io_service::strand]
+Destructor.
- friend bool operator==(
- const address_v4 & a1,
- const address_v4 & a2);
+ ~strand();
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
+Destroys a strand.
-[*Convenience header: ][^boost/asio.hpp]
+Handlers posted through the strand that have not yet been invoked will still be dispatched in a way that meets the guarantee of non-concurrency.
[endsect]
-[section:operator_gt_ ip::address_v4::operator>]
-
-[indexterm2 operator>..ip::address_v4]
-Compare addresses for ordering.
-
-
- friend bool operator>(
- const address_v4 & a1,
- const address_v4 & a2);
-
-
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
+[section:io_service__work io_service::work]
-[*Convenience header: ][^boost/asio.hpp]
+Class to inform the [link boost_asio.reference.io_service `io_service`] when it has work to do.
-[endsect]
+ class work
-[section:operator_gt__eq_ ip::address_v4::operator>=]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[indexterm2 operator>=..ip::address_v4]
-Compare addresses for ordering.
+ [
+ [[link boost_asio.reference.io_service__work.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the work. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__work.work [*work]]]
+ [Constructor notifies the io_service that work is starting.
+ Copy constructor notifies the io_service that work is starting. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__work._work [*~work]]]
+ [Destructor notifies the io_service that the work is complete. ]
+ ]
+
+]
- friend bool operator>=(
- const address_v4 & a1,
- const address_v4 & a2);
+The work class is used to inform the [link boost_asio.reference.io_service `io_service`] when work starts and finishes. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while work is underway, and that it does exit when there is no unfinished work remaining.
+The work class is copy-constructible so that it may be used as a data member in a handler class. It is not assignable.
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v4.hpp]
+[*Header: ][^boost/asio/io_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:get_io_service io_service::work::get_io_service]
+[indexterm2 get_io_service..io_service::work]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the work.
-[section:to_bytes ip::address_v4::to_bytes]
+ boost::asio::io_service & get_io_service();
-[indexterm2 to_bytes..ip::address_v4]
-Get the address in bytes, in network byte order.
- bytes_type to_bytes() const;
+[endsect]
+[section:work io_service::work::work]
-[endsect]
+[indexterm2 work..io_service::work]
+Constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
-[section:to_string ip::address_v4::to_string]
+ explicit ``[link boost_asio.reference.io_service__work.work.overload1 work]``(
+ boost::asio::io_service & io_service);
+ `` [''''»''' [link boost_asio.reference.io_service__work.work.overload1 more...]]``
-[indexterm2 to_string..ip::address_v4]
-Get the address as a string in dotted decimal format.
+Copy constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
- std::string ``[link boost_asio.reference.ip__address_v4.to_string.overload1 to_string]``() const;
- `` [''''»''' [link boost_asio.reference.ip__address_v4.to_string.overload1 more...]]``
- std::string ``[link boost_asio.reference.ip__address_v4.to_string.overload2 to_string]``(
- boost::system::error_code & ec) const;
- `` [''''»''' [link boost_asio.reference.ip__address_v4.to_string.overload2 more...]]``
+ ``[link boost_asio.reference.io_service__work.work.overload2 work]``(
+ const work & other);
+ `` [''''»''' [link boost_asio.reference.io_service__work.work.overload2 more...]]``
-[section:overload1 ip::address_v4::to_string (1 of 2 overloads)]
+[section:overload1 io_service::work::work (1 of 2 overloads)]
-Get the address as a string in dotted decimal format.
+Constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
- std::string to_string() const;
+ work(
+ boost::asio::io_service & io_service);
+
+The constructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has begun. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while the work is underway.
[endsect]
-[section:overload2 ip::address_v4::to_string (2 of 2 overloads)]
-
+[section:overload2 io_service::work::work (2 of 2 overloads)]
-Get the address as a string in dotted decimal format.
+Copy constructor notifies the [link boost_asio.reference.io_service `io_service`] that work is starting.
- std::string to_string(
- boost::system::error_code & ec) const;
+ work(
+ const work & other);
-[endsect]
+The constructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has begun. This ensures that the [link boost_asio.reference.io_service `io_service`] object's `run()` function will not exit while the work is underway.
[endsect]
-[section:to_ulong ip::address_v4::to_ulong]
+[endsect]
-[indexterm2 to_ulong..ip::address_v4]
-Get the address as an unsigned long in host byte order.
+[section:_work io_service::work::~work]
- unsigned long to_ulong() const;
+[indexterm2 ~work..io_service::work]
+Destructor notifies the [link boost_asio.reference.io_service `io_service`] that the work is complete.
+ ~work();
-[endsect]
+The destructor is used to inform the [link boost_asio.reference.io_service `io_service`] that some work has finished. Once the count of unfinished work reaches zero, the [link boost_asio.reference.io_service `io_service`] object's `run()` function is permitted to exit.
[endsect]
-[section:ip__address_v6 ip::address_v6]
-
-Implements IP version 6 style addresses.
+[endsect]
- class address_v6
+[section:ip__address ip::address]
-[heading Types]
-[table
- [[Name][Description]]
+Implements version-independent IP addresses.
- [
- [[link boost_asio.reference.ip__address_v6.bytes_type [*bytes_type]]]
- [The type used to represent an address as an array of bytes. ]
-
- ]
+ class address
-]
[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ip__address_v6.address_v6 [*address_v6]]]
+ [[link boost_asio.reference.ip__address.address [*address]]]
[Default constructor.
- Construct an address from raw bytes and scope ID.
+ Construct an address from an IPv4 address.
+
+ Construct an address from an IPv6 address.
Copy constructor. ]
]
[
- [[link boost_asio.reference.ip__address_v6.any [*any]]]
- [Obtain an address object that represents any address. ]
+ [[link boost_asio.reference.ip__address.from_string [*from_string]]]
+ [Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation. ]
]
[
- [[link boost_asio.reference.ip__address_v6.from_string [*from_string]]]
- [Create an address from an IP address string. ]
+ [[link boost_asio.reference.ip__address.is_loopback [*is_loopback]]]
+ [Determine whether the address is a loopback address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_link_local [*is_link_local]]]
- [Determine whether the address is link local. ]
+ [[link boost_asio.reference.ip__address.is_multicast [*is_multicast]]]
+ [Determine whether the address is a multicast address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_loopback [*is_loopback]]]
- [Determine whether the address is a loopback address. ]
+ [[link boost_asio.reference.ip__address.is_unspecified [*is_unspecified]]]
+ [Determine whether the address is unspecified. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast [*is_multicast]]]
- [Determine whether the address is a multicast address. ]
+ [[link boost_asio.reference.ip__address.is_v4 [*is_v4]]]
+ [Get whether the address is an IP version 4 address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast_global [*is_multicast_global]]]
- [Determine whether the address is a global multicast address. ]
+ [[link boost_asio.reference.ip__address.is_v6 [*is_v6]]]
+ [Get whether the address is an IP version 6 address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast_link_local [*is_multicast_link_local]]]
- [Determine whether the address is a link-local multicast address. ]
+ [[link boost_asio.reference.ip__address.operator_eq_ [*operator=]]]
+ [Assign from another address.
+
+ Assign from an IPv4 address.
+
+ Assign from an IPv6 address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast_node_local [*is_multicast_node_local]]]
- [Determine whether the address is a node-local multicast address. ]
+ [[link boost_asio.reference.ip__address.to_string [*to_string]]]
+ [Get the address as a string in dotted decimal format. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast_org_local [*is_multicast_org_local]]]
- [Determine whether the address is a org-local multicast address. ]
+ [[link boost_asio.reference.ip__address.to_v4 [*to_v4]]]
+ [Get the address as an IP version 4 address. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_multicast_site_local [*is_multicast_site_local]]]
- [Determine whether the address is a site-local multicast address. ]
+ [[link boost_asio.reference.ip__address.to_v6 [*to_v6]]]
+ [Get the address as an IP version 6 address. ]
]
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.ip__address_v6.is_site_local [*is_site_local]]]
- [Determine whether the address is site local. ]
+ [[link boost_asio.reference.ip__address.operator_not__eq_ [*operator!=]]]
+ [Compare two addresses for inequality. ]
]
[
- [[link boost_asio.reference.ip__address_v6.is_unspecified [*is_unspecified]]]
- [Determine whether the address is unspecified. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.is_v4_compatible [*is_v4_compatible]]]
- [Determine whether the address is an IPv4-compatible address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.is_v4_mapped [*is_v4_mapped]]]
- [Determine whether the address is a mapped IPv4 address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.loopback [*loopback]]]
- [Obtain an address object that represents the loopback address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.operator_eq_ [*operator=]]]
- [Assign from another address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.scope_id [*scope_id]]]
- [The scope ID of the address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.to_bytes [*to_bytes]]]
- [Get the address in bytes, in network byte order. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.to_string [*to_string]]]
- [Get the address as a string. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.to_v4 [*to_v4]]]
- [Converts an IPv4-mapped or IPv4-compatible address to an IPv4 address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.v4_compatible [*v4_compatible]]]
- [Create an IPv4-compatible IPv6 address. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.v4_mapped [*v4_mapped]]]
- [Create an IPv4-mapped IPv6 address. ]
- ]
-
-]
-
-[heading Friends]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.ip__address_v6.operator_not__eq_ [*operator!=]]]
- [Compare two addresses for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__address_v6.operator_lt_ [*operator<]]]
+ [[link boost_asio.reference.ip__address.operator_lt_ [*operator<]]]
[Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__address_v6.operator_lt__eq_ [*operator<=]]]
+ [[link boost_asio.reference.ip__address.operator_lt__eq_ [*operator<=]]]
[Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__address_v6.operator_eq__eq_ [*operator==]]]
+ [[link boost_asio.reference.ip__address.operator_eq__eq_ [*operator==]]]
[Compare two addresses for equality. ]
]
[
- [[link boost_asio.reference.ip__address_v6.operator_gt_ [*operator>]]]
+ [[link boost_asio.reference.ip__address.operator_gt_ [*operator>]]]
[Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__address_v6.operator_gt__eq_ [*operator>=]]]
+ [[link boost_asio.reference.ip__address.operator_gt__eq_ [*operator>=]]]
[Compare addresses for ordering. ]
]
@@ -56331,13 +56276,13 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__address_v6.operator_lt__lt_ [*operator<<]]]
+ [[link boost_asio.reference.ip__address.operator_lt__lt_ [*operator<<]]]
[Output an address as a string. ]
]
]
-The [link boost_asio.reference.ip__address_v6 `ip::address_v6`] class provides the ability to use and manipulate IP version 6 addresses.
+The [link boost_asio.reference.ip__address `ip::address`] class provides the ability to use either IP version 4 or version 6 addresses.
[heading Thread Safety]
@@ -56350,60 +56295,51 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Header: ][^boost/asio/ip/address.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:address_v6 ip::address_v6::address_v6]
+[section:address ip::address::address]
-[indexterm2 address_v6..ip::address_v6]
+[indexterm2 address..ip::address]
Default constructor.
- ``[link boost_asio.reference.ip__address_v6.address_v6.overload1 address_v6]``();
- `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload1 more...]]``
-
-
-Construct an address from raw bytes and scope ID.
-
-
- explicit ``[link boost_asio.reference.ip__address_v6.address_v6.overload2 address_v6]``(
- const bytes_type & bytes,
- unsigned long scope_id = 0);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload2 more...]]``
-
-
-Copy constructor.
+ ``[link boost_asio.reference.ip__address.address.overload1 address]``();
+ `` [''''»''' [link boost_asio.reference.ip__address.address.overload1 more...]]``
- ``[link boost_asio.reference.ip__address_v6.address_v6.overload3 address_v6]``(
- const address_v6 & other);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload3 more...]]``
+Construct an address from an IPv4 address.
-[section:overload1 ip::address_v6::address_v6 (1 of 3 overloads)]
+ ``[link boost_asio.reference.ip__address.address.overload2 address]``(
+ const boost::asio::ip::address_v4 & ipv4_address);
+ `` [''''»''' [link boost_asio.reference.ip__address.address.overload2 more...]]``
-Default constructor.
+Construct an address from an IPv6 address.
- address_v6();
+ ``[link boost_asio.reference.ip__address.address.overload3 address]``(
+ const boost::asio::ip::address_v6 & ipv6_address);
+ `` [''''»''' [link boost_asio.reference.ip__address.address.overload3 more...]]``
+Copy constructor.
-[endsect]
+ ``[link boost_asio.reference.ip__address.address.overload4 address]``(
+ const address & other);
+ `` [''''»''' [link boost_asio.reference.ip__address.address.overload4 more...]]``
-[section:overload2 ip::address_v6::address_v6 (2 of 3 overloads)]
+[section:overload1 ip::address::address (1 of 4 overloads)]
-Construct an address from raw bytes and scope ID.
+Default constructor.
- address_v6(
- const bytes_type & bytes,
- unsigned long scope_id = 0);
+ address();
@@ -56411,30 +56347,29 @@
-[section:overload3 ip::address_v6::address_v6 (3 of 3 overloads)]
+[section:overload2 ip::address::address (2 of 4 overloads)]
-Copy constructor.
+Construct an address from an IPv4 address.
- address_v6(
- const address_v6 & other);
+ address(
+ const boost::asio::ip::address_v4 & ipv4_address);
[endsect]
-[endsect]
+[section:overload3 ip::address::address (3 of 4 overloads)]
-[section:any ip::address_v6::any]
-[indexterm2 any..ip::address_v6]
-Obtain an address object that represents any address.
+Construct an address from an IPv6 address.
- static address_v6 any();
+ address(
+ const boost::asio::ip::address_v6 & ipv6_address);
@@ -56442,65 +56377,54 @@
-[section:bytes_type ip::address_v6::bytes_type]
-
-[indexterm2 bytes_type..ip::address_v6]
-The type used to represent an address as an array of bytes.
-
-
- typedef array< unsigned char, 16 > bytes_type;
-
-
+[section:overload4 ip::address::address (4 of 4 overloads)]
-[heading Remarks]
-
-This type is defined in terms of the C++0x template `std::array` when it is available. Otherwise, it uses `boost:array`.
+Copy constructor.
+ address(
+ const address & other);
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:from_string ip::address::from_string]
-[section:from_string ip::address_v6::from_string]
-
-[indexterm2 from_string..ip::address_v6]
-Create an address from an IP address string.
+[indexterm2 from_string..ip::address]
+Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
- static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload1 from_string]``(
+ static address ``[link boost_asio.reference.ip__address.from_string.overload1 from_string]``(
const char * str);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload1 more...]]``
- static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload2 from_string]``(
+ static address ``[link boost_asio.reference.ip__address.from_string.overload2 from_string]``(
const char * str,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload2 more...]]``
- static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload3 from_string]``(
+ static address ``[link boost_asio.reference.ip__address.from_string.overload3 from_string]``(
const std::string & str);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload3 more...]]``
+ `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload3 more...]]``
- static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload4 from_string]``(
+ static address ``[link boost_asio.reference.ip__address.from_string.overload4 from_string]``(
const std::string & str,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload4 more...]]``
+ `` [''''»''' [link boost_asio.reference.ip__address.from_string.overload4 more...]]``
-[section:overload1 ip::address_v6::from_string (1 of 4 overloads)]
+[section:overload1 ip::address::from_string (1 of 4 overloads)]
-Create an address from an IP address string.
+Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
- static address_v6 from_string(
+ static address from_string(
const char * str);
@@ -56509,13 +56433,13 @@
-[section:overload2 ip::address_v6::from_string (2 of 4 overloads)]
+[section:overload2 ip::address::from_string (2 of 4 overloads)]
-Create an address from an IP address string.
+Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
- static address_v6 from_string(
+ static address from_string(
const char * str,
boost::system::error_code & ec);
@@ -56525,13 +56449,13 @@
-[section:overload3 ip::address_v6::from_string (3 of 4 overloads)]
+[section:overload3 ip::address::from_string (3 of 4 overloads)]
-Create an address from an IP address string.
+Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
- static address_v6 from_string(
+ static address from_string(
const std::string & str);
@@ -56540,13 +56464,13 @@
-[section:overload4 ip::address_v6::from_string (4 of 4 overloads)]
+[section:overload4 ip::address::from_string (4 of 4 overloads)]
-Create an address from an IP address string.
+Create an address from an IPv4 address string in dotted decimal form, or from an IPv6 address in hexadecimal notation.
- static address_v6 from_string(
+ static address from_string(
const std::string & str,
boost::system::error_code & ec);
@@ -56558,23 +56482,9 @@
[endsect]
-[section:is_link_local ip::address_v6::is_link_local]
-
-[indexterm2 is_link_local..ip::address_v6]
-Determine whether the address is link local.
-
-
- bool is_link_local() const;
-
-
-
-[endsect]
-
-
-
-[section:is_loopback ip::address_v6::is_loopback]
+[section:is_loopback ip::address::is_loopback]
-[indexterm2 is_loopback..ip::address_v6]
+[indexterm2 is_loopback..ip::address]
Determine whether the address is a loopback address.
@@ -56586,9 +56496,9 @@
-[section:is_multicast ip::address_v6::is_multicast]
+[section:is_multicast ip::address::is_multicast]
-[indexterm2 is_multicast..ip::address_v6]
+[indexterm2 is_multicast..ip::address]
Determine whether the address is a multicast address.
@@ -56600,13 +56510,13 @@
-[section:is_multicast_global ip::address_v6::is_multicast_global]
+[section:is_unspecified ip::address::is_unspecified]
-[indexterm2 is_multicast_global..ip::address_v6]
-Determine whether the address is a global multicast address.
+[indexterm2 is_unspecified..ip::address]
+Determine whether the address is unspecified.
- bool is_multicast_global() const;
+ bool is_unspecified() const;
@@ -56614,13 +56524,13 @@
-[section:is_multicast_link_local ip::address_v6::is_multicast_link_local]
+[section:is_v4 ip::address::is_v4]
-[indexterm2 is_multicast_link_local..ip::address_v6]
-Determine whether the address is a link-local multicast address.
+[indexterm2 is_v4..ip::address]
+Get whether the address is an IP version 4 address.
- bool is_multicast_link_local() const;
+ bool is_v4() const;
@@ -56628,13 +56538,13 @@
-[section:is_multicast_node_local ip::address_v6::is_multicast_node_local]
+[section:is_v6 ip::address::is_v6]
-[indexterm2 is_multicast_node_local..ip::address_v6]
-Determine whether the address is a node-local multicast address.
+[indexterm2 is_v6..ip::address]
+Get whether the address is an IP version 6 address.
- bool is_multicast_node_local() const;
+ bool is_v6() const;
@@ -56642,97 +56552,83 @@
-[section:is_multicast_org_local ip::address_v6::is_multicast_org_local]
-
-[indexterm2 is_multicast_org_local..ip::address_v6]
-Determine whether the address is a org-local multicast address.
-
-
- bool is_multicast_org_local() const;
-
-
-
-[endsect]
+[section:operator_not__eq_ ip::address::operator!=]
+[indexterm2 operator!=..ip::address]
+Compare two addresses for inequality.
-[section:is_multicast_site_local ip::address_v6::is_multicast_site_local]
+ friend bool operator!=(
+ const address & a1,
+ const address & a2);
-[indexterm2 is_multicast_site_local..ip::address_v6]
-Determine whether the address is a site-local multicast address.
+[heading Requirements]
- bool is_multicast_site_local() const;
+[*Header: ][^boost/asio/ip/address.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:is_site_local ip::address_v6::is_site_local]
-
-[indexterm2 is_site_local..ip::address_v6]
-Determine whether the address is site local.
-
-
- bool is_site_local() const;
-
-
-
-[endsect]
+[section:operator_lt_ ip::address::operator<]
+[indexterm2 operator<..ip::address]
+Compare addresses for ordering.
-[section:is_unspecified ip::address_v6::is_unspecified]
+ friend bool operator<(
+ const address & a1,
+ const address & a2);
-[indexterm2 is_unspecified..ip::address_v6]
-Determine whether the address is unspecified.
+[heading Requirements]
- bool is_unspecified() const;
+[*Header: ][^boost/asio/ip/address.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:is_v4_compatible ip::address_v6::is_v4_compatible]
-
-[indexterm2 is_v4_compatible..ip::address_v6]
-Determine whether the address is an IPv4-compatible address.
-
-
- bool is_v4_compatible() const;
-
-
-
-[endsect]
-
-
+[section:operator_lt__lt_ ip::address::operator<<]
-[section:is_v4_mapped ip::address_v6::is_v4_mapped]
+[indexterm2 operator<<..ip::address]
+Output an address as a string.
-[indexterm2 is_v4_mapped..ip::address_v6]
-Determine whether the address is a mapped IPv4 address.
+ template<
+ typename Elem,
+ typename Traits>
+ std::basic_ostream< Elem, Traits > & operator<<(
+ std::basic_ostream< Elem, Traits > & os,
+ const address & addr);
- bool is_v4_mapped() const;
+Used to output a human-readable string for a specified address.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[os][The output stream to which the string will be written.]]
+[[addr][The address to be written.]]
-[section:loopback ip::address_v6::loopback]
+]
-[indexterm2 loopback..ip::address_v6]
-Obtain an address object that represents the loopback address.
+[heading Return Value]
+
+The output stream.
- static address_v6 loopback();
@@ -56740,20 +56636,20 @@
-[section:operator_not__eq_ ip::address_v6::operator!=]
+[section:operator_lt__eq_ ip::address::operator<=]
-[indexterm2 operator!=..ip::address_v6]
-Compare two addresses for inequality.
+[indexterm2 operator<=..ip::address]
+Compare addresses for ordering.
- friend bool operator!=(
- const address_v6 & a1,
- const address_v6 & a2);
+ friend bool operator<=(
+ const address & a1,
+ const address & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Header: ][^boost/asio/ip/address.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -56761,120 +56657,94 @@
[endsect]
+[section:operator_eq_ ip::address::operator=]
-[section:operator_lt_ ip::address_v6::operator<]
-
-[indexterm2 operator<..ip::address_v6]
-Compare addresses for ordering.
+[indexterm2 operator=..ip::address]
+Assign from another address.
- friend bool operator<(
- const address_v6 & a1,
- const address_v6 & a2);
+ address & ``[link boost_asio.reference.ip__address.operator_eq_.overload1 operator=]``(
+ const address & other);
+ `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload1 more...]]``
-[heading Requirements]
+Assign from an IPv4 address.
-[*Header: ][^boost/asio/ip/address_v6.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ address & ``[link boost_asio.reference.ip__address.operator_eq_.overload2 operator=]``(
+ const boost::asio::ip::address_v4 & ipv4_address);
+ `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload2 more...]]``
-[endsect]
+Assign from an IPv6 address.
+ address & ``[link boost_asio.reference.ip__address.operator_eq_.overload3 operator=]``(
+ const boost::asio::ip::address_v6 & ipv6_address);
+ `` [''''»''' [link boost_asio.reference.ip__address.operator_eq_.overload3 more...]]``
-[section:operator_lt__lt_ ip::address_v6::operator<<]
-[indexterm2 operator<<..ip::address_v6]
-Output an address as a string.
+[section:overload1 ip::address::operator= (1 of 3 overloads)]
- template<
- typename Elem,
- typename Traits>
- std::basic_ostream< Elem, Traits > & operator<<(
- std::basic_ostream< Elem, Traits > & os,
- const address_v6 & addr);
+Assign from another address.
-Used to output a human-readable string for a specified address.
+ address & operator=(
+ const address & other);
-[heading Parameters]
-
-[variablelist
-
-[[os][The output stream to which the string will be written.]]
+[endsect]
-[[addr][The address to be written.]]
-]
+[section:overload2 ip::address::operator= (2 of 3 overloads)]
-[heading Return Value]
-
-The output stream.
+Assign from an IPv4 address.
+ address & operator=(
+ const boost::asio::ip::address_v4 & ipv4_address);
-[endsect]
+[endsect]
-[section:operator_lt__eq_ ip::address_v6::operator<=]
-[indexterm2 operator<=..ip::address_v6]
-Compare addresses for ordering.
+[section:overload3 ip::address::operator= (3 of 3 overloads)]
- friend bool operator<=(
- const address_v6 & a1,
- const address_v6 & a2);
+Assign from an IPv6 address.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+ address & operator=(
+ const boost::asio::ip::address_v6 & ipv6_address);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:operator_eq_ ip::address_v6::operator=]
-
-[indexterm2 operator=..ip::address_v6]
-Assign from another address.
-
-
- address_v6 & operator=(
- const address_v6 & other);
-
-
-
[endsect]
+[section:operator_eq__eq_ ip::address::operator==]
-[section:operator_eq__eq_ ip::address_v6::operator==]
-
-[indexterm2 operator==..ip::address_v6]
+[indexterm2 operator==..ip::address]
Compare two addresses for equality.
friend bool operator==(
- const address_v6 & a1,
- const address_v6 & a2);
+ const address & a1,
+ const address & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Header: ][^boost/asio/ip/address.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -56883,20 +56753,20 @@
-[section:operator_gt_ ip::address_v6::operator>]
+[section:operator_gt_ ip::address::operator>]
-[indexterm2 operator>..ip::address_v6]
+[indexterm2 operator>..ip::address]
Compare addresses for ordering.
friend bool operator>(
- const address_v6 & a1,
- const address_v6 & a2);
+ const address & a1,
+ const address & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Header: ][^boost/asio/ip/address.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -56905,20 +56775,20 @@
-[section:operator_gt__eq_ ip::address_v6::operator>=]
+[section:operator_gt__eq_ ip::address::operator>=]
-[indexterm2 operator>=..ip::address_v6]
+[indexterm2 operator>=..ip::address]
Compare addresses for ordering.
friend bool operator>=(
- const address_v6 & a1,
- const address_v6 & a2);
+ const address & a1,
+ const address & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Header: ][^boost/asio/ip/address.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -56926,47 +56796,43 @@
[endsect]
-[section:scope_id ip::address_v6::scope_id]
-
-[indexterm2 scope_id..ip::address_v6]
-The scope ID of the address.
+[section:to_string ip::address::to_string]
+[indexterm2 to_string..ip::address]
+Get the address as a string in dotted decimal format.
- unsigned long ``[link boost_asio.reference.ip__address_v6.scope_id.overload1 scope_id]``() const;
- `` [''''»''' [link boost_asio.reference.ip__address_v6.scope_id.overload1 more...]]``
- void ``[link boost_asio.reference.ip__address_v6.scope_id.overload2 scope_id]``(
- unsigned long id);
- `` [''''»''' [link boost_asio.reference.ip__address_v6.scope_id.overload2 more...]]``
+ std::string ``[link boost_asio.reference.ip__address.to_string.overload1 to_string]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__address.to_string.overload1 more...]]``
+ std::string ``[link boost_asio.reference.ip__address.to_string.overload2 to_string]``(
+ boost::system::error_code & ec) const;
+ `` [''''»''' [link boost_asio.reference.ip__address.to_string.overload2 more...]]``
-[section:overload1 ip::address_v6::scope_id (1 of 2 overloads)]
+[section:overload1 ip::address::to_string (1 of 2 overloads)]
-The scope ID of the address.
+Get the address as a string in dotted decimal format.
- unsigned long scope_id() const;
+ std::string to_string() const;
-Returns the scope ID associated with the IPv6 address.
[endsect]
-[section:overload2 ip::address_v6::scope_id (2 of 2 overloads)]
-
+[section:overload2 ip::address::to_string (2 of 2 overloads)]
-The scope ID of the address.
+Get the address as a string in dotted decimal format.
- void scope_id(
- unsigned long id);
+ std::string to_string(
+ boost::system::error_code & ec) const;
-Modifies the scope ID associated with the IPv6 address.
[endsect]
@@ -56975,86 +56841,13 @@
[endsect]
-[section:to_bytes ip::address_v6::to_bytes]
+[section:to_v4 ip::address::to_v4]
-[indexterm2 to_bytes..ip::address_v6]
-Get the address in bytes, in network byte order.
-
-
- bytes_type to_bytes() const;
-
-
-
-[endsect]
-
-
-[section:to_string ip::address_v6::to_string]
-
-[indexterm2 to_string..ip::address_v6]
-Get the address as a string.
-
-
- std::string ``[link boost_asio.reference.ip__address_v6.to_string.overload1 to_string]``() const;
- `` [''''»''' [link boost_asio.reference.ip__address_v6.to_string.overload1 more...]]``
-
- std::string ``[link boost_asio.reference.ip__address_v6.to_string.overload2 to_string]``(
- boost::system::error_code & ec) const;
- `` [''''»''' [link boost_asio.reference.ip__address_v6.to_string.overload2 more...]]``
-
-
-[section:overload1 ip::address_v6::to_string (1 of 2 overloads)]
-
-
-Get the address as a string.
-
-
- std::string to_string() const;
-
-
-
-[endsect]
-
-
-
-[section:overload2 ip::address_v6::to_string (2 of 2 overloads)]
-
-
-Get the address as a string.
-
-
- std::string to_string(
- boost::system::error_code & ec) const;
-
-
-
-[endsect]
-
-
-[endsect]
-
-
-[section:to_v4 ip::address_v6::to_v4]
-
-[indexterm2 to_v4..ip::address_v6]
-Converts an IPv4-mapped or IPv4-compatible address to an IPv4 address.
-
-
- address_v4 to_v4() const;
-
-
-
-[endsect]
-
-
-
-[section:v4_compatible ip::address_v6::v4_compatible]
-
-[indexterm2 v4_compatible..ip::address_v6]
-Create an IPv4-compatible IPv6 address.
+[indexterm2 to_v4..ip::address]
+Get the address as an IP version 4 address.
- static address_v6 v4_compatible(
- const address_v4 & addr);
+ boost::asio::ip::address_v4 to_v4() const;
@@ -57062,14 +56855,13 @@
-[section:v4_mapped ip::address_v6::v4_mapped]
+[section:to_v6 ip::address::to_v6]
-[indexterm2 v4_mapped..ip::address_v6]
-Create an IPv4-mapped IPv6 address.
+[indexterm2 to_v6..ip::address]
+Get the address as an IP version 6 address.
- static address_v6 v4_mapped(
- const address_v4 & addr);
+ boost::asio::ip::address_v6 to_v6() const;
@@ -57079,15 +56871,13 @@
[endsect]
-[section:ip__basic_endpoint ip::basic_endpoint]
+[section:ip__address_v4 ip::address_v4]
-Describes an endpoint for a version-independent IP socket.
+Implements IP version 4 style addresses.
- template<
- typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
- class basic_endpoint
+ class address_v4
[heading Types]
@@ -57096,15 +56886,8 @@
[
- [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
+ [[link boost_asio.reference.ip__address_v4.bytes_type [*bytes_type]]]
+ [The type used to represent an address as an array of bytes. ]
]
@@ -57115,58 +56898,91 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
- [Get the IP address associated with the endpoint.
-
- Set the IP address associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [[link boost_asio.reference.ip__address_v4.address_v4 [*address_v4]]]
[Default constructor.
- Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
+ Construct an address from raw bytes.
- Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+ Construct an address from a unsigned long in host byte order.
Copy constructor. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__address_v4.any [*any]]]
+ [Obtain an address object that represents any address. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
+ [[link boost_asio.reference.ip__address_v4.broadcast [*broadcast]]]
+ [Obtain an address object that represents the broadcast address.
+
+ Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
+ [[link boost_asio.reference.ip__address_v4.from_string [*from_string]]]
+ [Create an address from an IP address string in dotted decimal form. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
- [Get the port associated with the endpoint. The port number is always in the host's byte order.
-
- Set the port associated with the endpoint. The port number is always in the host's byte order. ]
+ [[link boost_asio.reference.ip__address_v4.is_class_a [*is_class_a]]]
+ [Determine whether the address is a class A address. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
+ [[link boost_asio.reference.ip__address_v4.is_class_b [*is_class_b]]]
+ [Determine whether the address is a class B address. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__address_v4.is_class_c [*is_class_c]]]
+ [Determine whether the address is a class C address. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__address_v4.is_loopback [*is_loopback]]]
+ [Determine whether the address is a loopback address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.is_multicast [*is_multicast]]]
+ [Determine whether the address is a multicast address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.is_unspecified [*is_unspecified]]]
+ [Determine whether the address is unspecified. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.loopback [*loopback]]]
+ [Obtain an address object that represents the loopback address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.netmask [*netmask]]]
+ [Obtain the netmask that corresponds to the address, based on its address class. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.operator_eq_ [*operator=]]]
+ [Assign from another address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.to_bytes [*to_bytes]]]
+ [Get the address in bytes, in network byte order. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.to_string [*to_string]]]
+ [Get the address as a string in dotted decimal format. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v4.to_ulong [*to_ulong]]]
+ [Get the address as an unsigned long in host byte order. ]
]
]
@@ -57176,33 +56992,33 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
+ [[link boost_asio.reference.ip__address_v4.operator_not__eq_ [*operator!=]]]
+ [Compare two addresses for inequality. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__address_v4.operator_lt_ [*operator<]]]
+ [Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__address_v4.operator_lt__eq_ [*operator<=]]]
+ [Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
+ [[link boost_asio.reference.ip__address_v4.operator_eq__eq_ [*operator==]]]
+ [Compare two addresses for equality. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__address_v4.operator_gt_ [*operator>]]]
+ [Compare addresses for ordering. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__address_v4.operator_gt__eq_ [*operator>=]]]
+ [Compare addresses for ordering. ]
]
]
@@ -57212,170 +57028,163 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
+ [[link boost_asio.reference.ip__address_v4.operator_lt__lt_ [*operator<<]]]
+ [Output an address as a string. ]
]
]
-The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
+The [link boost_asio.reference.ip__address_v4 `ip::address_v4`] class provides the ability to use and manipulate IP version 4 addresses.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
-
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Header: ][^boost/asio/ip/address_v4.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:address ip::basic_endpoint::address]
-
-[indexterm2 address..ip::basic_endpoint]
-Get the IP address associated with the endpoint.
-
+[section:address_v4 ip::address_v4::address_v4]
- boost::asio::ip::address ``[link boost_asio.reference.ip__basic_endpoint.address.overload1 address]``() const;
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.address.overload1 more...]]``
+[indexterm2 address_v4..ip::address_v4]
+Default constructor.
-Set the IP address associated with the endpoint.
+ ``[link boost_asio.reference.ip__address_v4.address_v4.overload1 address_v4]``();
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload1 more...]]``
- void ``[link boost_asio.reference.ip__basic_endpoint.address.overload2 address]``(
- const boost::asio::ip::address & addr);
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.address.overload2 more...]]``
+Construct an address from raw bytes.
-[section:overload1 ip::basic_endpoint::address (1 of 2 overloads)]
+ explicit ``[link boost_asio.reference.ip__address_v4.address_v4.overload2 address_v4]``(
+ const bytes_type & bytes);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload2 more...]]``
-Get the IP address associated with the endpoint.
+Construct an address from a unsigned long in host byte order.
- boost::asio::ip::address address() const;
+ explicit ``[link boost_asio.reference.ip__address_v4.address_v4.overload3 address_v4]``(
+ unsigned long addr);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload3 more...]]``
+Copy constructor.
-[endsect]
+ ``[link boost_asio.reference.ip__address_v4.address_v4.overload4 address_v4]``(
+ const address_v4 & other);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.address_v4.overload4 more...]]``
-[section:overload2 ip::basic_endpoint::address (2 of 2 overloads)]
+[section:overload1 ip::address_v4::address_v4 (1 of 4 overloads)]
-Set the IP address associated with the endpoint.
+Default constructor.
- void address(
- const boost::asio::ip::address & addr);
+ address_v4();
[endsect]
-[endsect]
-[section:basic_endpoint ip::basic_endpoint::basic_endpoint]
+[section:overload2 ip::address_v4::address_v4 (2 of 4 overloads)]
-[indexterm2 basic_endpoint..ip::basic_endpoint]
-Default constructor.
+Construct an address from raw bytes.
- ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload1 basic_endpoint]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload1 more...]]``
+ address_v4(
+ const bytes_type & bytes);
-Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR\_ANY or in6addr\_any). This constructor would typically be used for accepting new connections.
- ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload2 basic_endpoint]``(
- const InternetProtocol & internet_protocol,
- unsigned short port_num);
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload2 more...]]``
+[endsect]
-Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+[section:overload3 ip::address_v4::address_v4 (3 of 4 overloads)]
- ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload3 basic_endpoint]``(
- const boost::asio::ip::address & addr,
- unsigned short port_num);
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload3 more...]]``
+Construct an address from a unsigned long in host byte order.
-Copy constructor.
+ address_v4(
+ unsigned long addr);
- ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload4 basic_endpoint]``(
- const basic_endpoint & other);
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload4 more...]]``
-[section:overload1 ip::basic_endpoint::basic_endpoint (1 of 4 overloads)]
+[endsect]
-Default constructor.
+[section:overload4 ip::address_v4::address_v4 (4 of 4 overloads)]
- basic_endpoint();
+Copy constructor.
-[endsect]
+ address_v4(
+ const address_v4 & other);
-[section:overload2 ip::basic_endpoint::basic_endpoint (2 of 4 overloads)]
+[endsect]
-Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR\_ANY or in6addr\_any). This constructor would typically be used for accepting new connections.
+[endsect]
- basic_endpoint(
- const InternetProtocol & internet_protocol,
- unsigned short port_num);
+[section:any ip::address_v4::any]
+[indexterm2 any..ip::address_v4]
+Obtain an address object that represents any address.
-[heading Examples]
-
-To initialise an IPv4 TCP endpoint for port 1234, use:
+ static address_v4 any();
- boost::asio::ip::tcp::endpoint ep(boost::asio::ip::tcp::v4(), 1234);
+[endsect]
-To specify an IPv6 UDP endpoint for port 9876, use:
+[section:broadcast ip::address_v4::broadcast]
- boost::asio::ip::udp::endpoint ep(boost::asio::ip::udp::v6(), 9876);
+[indexterm2 broadcast..ip::address_v4]
+Obtain an address object that represents the broadcast address.
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.broadcast.overload1 broadcast]``();
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.broadcast.overload1 more...]]``
+Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask.
-[endsect]
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.broadcast.overload2 broadcast]``(
+ const address_v4 & addr,
+ const address_v4 & mask);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.broadcast.overload2 more...]]``
-[section:overload3 ip::basic_endpoint::basic_endpoint (3 of 4 overloads)]
+[section:overload1 ip::address_v4::broadcast (1 of 2 overloads)]
-Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+Obtain an address object that represents the broadcast address.
- basic_endpoint(
- const boost::asio::ip::address & addr,
- unsigned short port_num);
+ static address_v4 broadcast();
@@ -57383,14 +57192,15 @@
-[section:overload4 ip::basic_endpoint::basic_endpoint (4 of 4 overloads)]
+[section:overload2 ip::address_v4::broadcast (2 of 2 overloads)]
-Copy constructor.
+Obtain an address object that represents the broadcast address that corresponds to the specified address and netmask.
- basic_endpoint(
- const basic_endpoint & other);
+ static address_v4 broadcast(
+ const address_v4 & addr,
+ const address_v4 & mask);
@@ -57400,194 +57210,199 @@
[endsect]
-[section:capacity ip::basic_endpoint::capacity]
+[section:bytes_type ip::address_v4::bytes_type]
-[indexterm2 capacity..ip::basic_endpoint]
-Get the capacity of the endpoint in the native type.
+[indexterm2 bytes_type..ip::address_v4]
+The type used to represent an address as an array of bytes.
- std::size_t capacity() const;
+ typedef array< unsigned char, 4 > bytes_type;
-[endsect]
+[heading Remarks]
+
+This type is defined in terms of the C++0x template `std::array` when it is available. Otherwise, it uses `boost:array`.
-[section:data ip::basic_endpoint::data]
-[indexterm2 data..ip::basic_endpoint]
-Get the underlying endpoint in the native type.
+[heading Requirements]
- data_type * ``[link boost_asio.reference.ip__basic_endpoint.data.overload1 data]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.data.overload1 more...]]``
+[*Header: ][^boost/asio/ip/address_v4.hpp]
- const data_type * ``[link boost_asio.reference.ip__basic_endpoint.data.overload2 data]``() const;
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.data.overload2 more...]]``
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload1 ip::basic_endpoint::data (1 of 2 overloads)]
+[endsect]
-Get the underlying endpoint in the native type.
+[section:from_string ip::address_v4::from_string]
+[indexterm2 from_string..ip::address_v4]
+Create an address from an IP address string in dotted decimal form.
- data_type * data();
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload1 from_string]``(
+ const char * str);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload1 more...]]``
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload2 from_string]``(
+ const char * str,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload2 more...]]``
-[endsect]
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload3 from_string]``(
+ const std::string & str);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload3 more...]]``
+ static address_v4 ``[link boost_asio.reference.ip__address_v4.from_string.overload4 from_string]``(
+ const std::string & str,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.from_string.overload4 more...]]``
-[section:overload2 ip::basic_endpoint::data (2 of 2 overloads)]
+[section:overload1 ip::address_v4::from_string (1 of 4 overloads)]
-Get the underlying endpoint in the native type.
+Create an address from an IP address string in dotted decimal form.
- const data_type * data() const;
+ static address_v4 from_string(
+ const char * str);
[endsect]
-[endsect]
+[section:overload2 ip::address_v4::from_string (2 of 4 overloads)]
-[section:data_type ip::basic_endpoint::data_type]
-[indexterm2 data_type..ip::basic_endpoint]
-The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer.
+Create an address from an IP address string in dotted decimal form.
- typedef implementation_defined data_type;
+ static address_v4 from_string(
+ const char * str,
+ boost::system::error_code & ec);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+
+[section:overload3 ip::address_v4::from_string (3 of 4 overloads)]
+
+
+Create an address from an IP address string in dotted decimal form.
+
+
+ static address_v4 from_string(
+ const std::string & str);
+
[endsect]
-[section:operator_not__eq_ ip::basic_endpoint::operator!=]
+[section:overload4 ip::address_v4::from_string (4 of 4 overloads)]
-[indexterm2 operator!=..ip::basic_endpoint]
-Compare two endpoints for inequality.
+Create an address from an IP address string in dotted decimal form.
- friend bool operator!=(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
+ static address_v4 from_string(
+ const std::string & str,
+ boost::system::error_code & ec);
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:is_class_a ip::address_v4::is_class_a]
-[section:operator_lt_ ip::basic_endpoint::operator<]
+[indexterm2 is_class_a..ip::address_v4]
+Determine whether the address is a class A address.
-[indexterm2 operator<..ip::basic_endpoint]
-Compare endpoints for ordering.
+ bool is_class_a() const;
- friend bool operator<(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:is_class_b ip::address_v4::is_class_b]
-[endsect]
+[indexterm2 is_class_b..ip::address_v4]
+Determine whether the address is a class B address.
+ bool is_class_b() const;
-[section:operator_lt__lt_ ip::basic_endpoint::operator<<]
-[indexterm2 operator<<..ip::basic_endpoint]
-Output an endpoint as a string.
+[endsect]
- std::basic_ostream< Elem, Traits > & operator<<(
- std::basic_ostream< Elem, Traits > & os,
- const basic_endpoint< InternetProtocol > & endpoint);
-Used to output a human-readable string for a specified endpoint.
+[section:is_class_c ip::address_v4::is_class_c]
+[indexterm2 is_class_c..ip::address_v4]
+Determine whether the address is a class C address.
-[heading Parameters]
-
-[variablelist
-
-[[os][The output stream to which the string will be written.]]
+ bool is_class_c() const;
-[[endpoint][The endpoint to be written.]]
-]
+[endsect]
-[heading Return Value]
-
-The output stream.
+[section:is_loopback ip::address_v4::is_loopback]
+[indexterm2 is_loopback..ip::address_v4]
+Determine whether the address is a loopback address.
-[endsect]
+ bool is_loopback() const;
-[section:operator_lt__eq_ ip::basic_endpoint::operator<=]
-[indexterm2 operator<=..ip::basic_endpoint]
-Compare endpoints for ordering.
+[endsect]
- friend bool operator<=(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
+[section:is_multicast ip::address_v4::is_multicast]
-[heading Requirements]
+[indexterm2 is_multicast..ip::address_v4]
+Determine whether the address is a multicast address.
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ bool is_multicast() const;
+
[endsect]
-[section:operator_eq_ ip::basic_endpoint::operator=]
+[section:is_unspecified ip::address_v4::is_unspecified]
-[indexterm2 operator=..ip::basic_endpoint]
-Assign from another endpoint.
+[indexterm2 is_unspecified..ip::address_v4]
+Determine whether the address is unspecified.
- basic_endpoint & operator=(
- const basic_endpoint & other);
+ bool is_unspecified() const;
@@ -57595,42 +57410,49 @@
-[section:operator_eq__eq_ ip::basic_endpoint::operator==]
+[section:loopback ip::address_v4::loopback]
-[indexterm2 operator==..ip::basic_endpoint]
-Compare two endpoints for equality.
+[indexterm2 loopback..ip::address_v4]
+Obtain an address object that represents the loopback address.
- friend bool operator==(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
+ static address_v4 loopback();
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[endsect]
+
+
+
+[section:netmask ip::address_v4::netmask]
+
+[indexterm2 netmask..ip::address_v4]
+Obtain the netmask that corresponds to the address, based on its address class.
+
+
+ static address_v4 netmask(
+ const address_v4 & addr);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:operator_gt_ ip::basic_endpoint::operator>]
+[section:operator_not__eq_ ip::address_v4::operator!=]
-[indexterm2 operator>..ip::basic_endpoint]
-Compare endpoints for ordering.
+[indexterm2 operator!=..ip::address_v4]
+Compare two addresses for inequality.
- friend bool operator>(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
+ friend bool operator!=(
+ const address_v4 & a1,
+ const address_v4 & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Header: ][^boost/asio/ip/address_v4.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -57639,20 +57461,20 @@
-[section:operator_gt__eq_ ip::basic_endpoint::operator>=]
+[section:operator_lt_ ip::address_v4::operator<]
-[indexterm2 operator>=..ip::basic_endpoint]
-Compare endpoints for ordering.
+[indexterm2 operator<..ip::address_v4]
+Compare addresses for ordering.
- friend bool operator>=(
- const basic_endpoint< InternetProtocol > & e1,
- const basic_endpoint< InternetProtocol > & e2);
+ friend bool operator<(
+ const address_v4 & a1,
+ const address_v4 & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Header: ][^boost/asio/ip/address_v4.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -57660,31 +57482,40 @@
[endsect]
-[section:port ip::basic_endpoint::port]
-[indexterm2 port..ip::basic_endpoint]
-Get the port associated with the endpoint. The port number is always in the host's byte order.
+[section:operator_lt__lt_ ip::address_v4::operator<<]
+
+[indexterm2 operator<<..ip::address_v4]
+Output an address as a string.
- unsigned short ``[link boost_asio.reference.ip__basic_endpoint.port.overload1 port]``() const;
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.port.overload1 more...]]``
+ template<
+ typename Elem,
+ typename Traits>
+ std::basic_ostream< Elem, Traits > & operator<<(
+ std::basic_ostream< Elem, Traits > & os,
+ const address_v4 & addr);
-Set the port associated with the endpoint. The port number is always in the host's byte order.
+Used to output a human-readable string for a specified address.
- void ``[link boost_asio.reference.ip__basic_endpoint.port.overload2 port]``(
- unsigned short port_num);
- `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.port.overload2 more...]]``
+[heading Parameters]
+
+[variablelist
+
+[[os][The output stream to which the string will be written.]]
-[section:overload1 ip::basic_endpoint::port (1 of 2 overloads)]
+[[addr][The address to be written.]]
+]
-Get the port associated with the endpoint. The port number is always in the host's byte order.
+[heading Return Value]
+
+The output stream.
- unsigned short port() const;
@@ -57692,50 +57523,101 @@
-[section:overload2 ip::basic_endpoint::port (2 of 2 overloads)]
+[section:operator_lt__eq_ ip::address_v4::operator<=]
+
+[indexterm2 operator<=..ip::address_v4]
+Compare addresses for ordering.
-Set the port associated with the endpoint. The port number is always in the host's byte order.
+ friend bool operator<=(
+ const address_v4 & a1,
+ const address_v4 & a2);
- void port(
- unsigned short port_num);
+[heading Requirements]
+[*Header: ][^boost/asio/ip/address_v4.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+
+[section:operator_eq_ ip::address_v4::operator=]
+
+[indexterm2 operator=..ip::address_v4]
+Assign from another address.
+
+
+ address_v4 & operator=(
+ const address_v4 & other);
+
+
+
[endsect]
-[section:protocol ip::basic_endpoint::protocol]
-[indexterm2 protocol..ip::basic_endpoint]
-The protocol associated with the endpoint.
+[section:operator_eq__eq_ ip::address_v4::operator==]
+
+[indexterm2 operator==..ip::address_v4]
+Compare two addresses for equality.
- protocol_type protocol() const;
+ friend bool operator==(
+ const address_v4 & a1,
+ const address_v4 & a2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/address_v4.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:protocol_type ip::basic_endpoint::protocol_type]
+[section:operator_gt_ ip::address_v4::operator>]
-[indexterm2 protocol_type..ip::basic_endpoint]
-The protocol type associated with the endpoint.
+[indexterm2 operator>..ip::address_v4]
+Compare addresses for ordering.
- typedef InternetProtocol protocol_type;
+ friend bool operator>(
+ const address_v4 & a1,
+ const address_v4 & a2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/address_v4.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_gt__eq_ ip::address_v4::operator>=]
+[indexterm2 operator>=..ip::address_v4]
+Compare addresses for ordering.
+
+
+ friend bool operator>=(
+ const address_v4 & a1,
+ const address_v4 & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Header: ][^boost/asio/ip/address_v4.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -57744,48 +57626,87 @@
-[section:resize ip::basic_endpoint::resize]
+[section:to_bytes ip::address_v4::to_bytes]
-[indexterm2 resize..ip::basic_endpoint]
-Set the underlying size of the endpoint in the native type.
+[indexterm2 to_bytes..ip::address_v4]
+Get the address in bytes, in network byte order.
- void resize(
- std::size_t new_size);
+ bytes_type to_bytes() const;
[endsect]
+[section:to_string ip::address_v4::to_string]
-[section:size ip::basic_endpoint::size]
+[indexterm2 to_string..ip::address_v4]
+Get the address as a string in dotted decimal format.
-[indexterm2 size..ip::basic_endpoint]
-Get the underlying size of the endpoint in the native type.
+ std::string ``[link boost_asio.reference.ip__address_v4.to_string.overload1 to_string]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.to_string.overload1 more...]]``
+
+ std::string ``[link boost_asio.reference.ip__address_v4.to_string.overload2 to_string]``(
+ boost::system::error_code & ec) const;
+ `` [''''»''' [link boost_asio.reference.ip__address_v4.to_string.overload2 more...]]``
+
+
+[section:overload1 ip::address_v4::to_string (1 of 2 overloads)]
+
+
+Get the address as a string in dotted decimal format.
+
+
+ std::string to_string() const;
- std::size_t size() const;
+[endsect]
+
+
+
+[section:overload2 ip::address_v4::to_string (2 of 2 overloads)]
+
+
+Get the address as a string in dotted decimal format.
+
+
+ std::string to_string(
+ boost::system::error_code & ec) const;
+
+
+
+[endsect]
+
[endsect]
+[section:to_ulong ip::address_v4::to_ulong]
+
+[indexterm2 to_ulong..ip::address_v4]
+Get the address as an unsigned long in host byte order.
+
+
+ unsigned long to_ulong() const;
+
+
[endsect]
-[section:ip__basic_resolver ip::basic_resolver]
-Provides endpoint resolution functionality.
+[endsect]
+[section:ip__address_v6 ip::address_v6]
- template<
- typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``,
- typename ``[link boost_asio.reference.ResolverService ResolverService]`` = resolver_service<InternetProtocol>>
- class basic_resolver :
- public basic_io_object< ResolverService >
+
+Implements IP version 6 style addresses.
+
+
+ class address_v6
[heading Types]
@@ -57794,116 +57715,186 @@
[
- [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
+ [[link boost_asio.reference.ip__address_v6.bytes_type [*bytes_type]]]
+ [The type used to represent an address as an array of bytes. ]
]
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
[
+ [[link boost_asio.reference.ip__address_v6.address_v6 [*address_v6]]]
+ [Default constructor.
- [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
+ Construct an address from raw bytes and scope ID.
+
+ Copy constructor. ]
+ ]
+ [
+ [[link boost_asio.reference.ip__address_v6.any [*any]]]
+ [Obtain an address object that represents any address. ]
]
-
+
[
-
- [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
- [The iterator type. ]
+ [[link boost_asio.reference.ip__address_v6.from_string [*from_string]]]
+ [Create an address from an IP address string. ]
+ ]
+ [
+ [[link boost_asio.reference.ip__address_v6.is_link_local [*is_link_local]]]
+ [Determine whether the address is link local. ]
]
-
+
[
-
- [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
- [The protocol type. ]
+ [[link boost_asio.reference.ip__address_v6.is_loopback [*is_loopback]]]
+ [Determine whether the address is a loopback address. ]
+ ]
+ [
+ [[link boost_asio.reference.ip__address_v6.is_multicast [*is_multicast]]]
+ [Determine whether the address is a multicast address. ]
]
-
+
[
-
- [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
- [The query type. ]
+ [[link boost_asio.reference.ip__address_v6.is_multicast_global [*is_multicast_global]]]
+ [Determine whether the address is a global multicast address. ]
+ ]
+ [
+ [[link boost_asio.reference.ip__address_v6.is_multicast_link_local [*is_multicast_link_local]]]
+ [Determine whether the address is a link-local multicast address. ]
]
-
+
[
-
- [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.ip__address_v6.is_multicast_node_local [*is_multicast_node_local]]]
+ [Determine whether the address is a node-local multicast address. ]
+ ]
+ [
+ [[link boost_asio.reference.ip__address_v6.is_multicast_org_local [*is_multicast_org_local]]]
+ [Determine whether the address is a org-local multicast address. ]
]
-
-]
-
-[heading Member Functions]
-[table
- [[Name][Description]]
-
+
[
- [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously perform forward resolution of a query to a list of entries.
-
- Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
+ [[link boost_asio.reference.ip__address_v6.is_multicast_site_local [*is_multicast_site_local]]]
+ [Determine whether the address is a site-local multicast address. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
- [Constructor. ]
+ [[link boost_asio.reference.ip__address_v6.is_site_local [*is_site_local]]]
+ [Determine whether the address is site local. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
- [Cancel any asynchronous operations that are waiting on the resolver. ]
+ [[link boost_asio.reference.ip__address_v6.is_unspecified [*is_unspecified]]]
+ [Determine whether the address is unspecified. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.ip__address_v6.is_v4_compatible [*is_v4_compatible]]]
+ [Determine whether the address is an IPv4-compatible address. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Perform forward resolution of a query to a list of entries.
-
- Perform reverse resolution of an endpoint to a list of entries. ]
+ [[link boost_asio.reference.ip__address_v6.is_v4_mapped [*is_v4_mapped]]]
+ [Determine whether the address is a mapped IPv4 address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.loopback [*loopback]]]
+ [Obtain an address object that represents the loopback address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.operator_eq_ [*operator=]]]
+ [Assign from another address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.scope_id [*scope_id]]]
+ [The scope ID of the address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.to_bytes [*to_bytes]]]
+ [Get the address in bytes, in network byte order. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.to_string [*to_string]]]
+ [Get the address as a string. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.to_v4 [*to_v4]]]
+ [Converts an IPv4-mapped or IPv4-compatible address to an IPv4 address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.v4_compatible [*v4_compatible]]]
+ [Create an IPv4-compatible IPv6 address. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.v4_mapped [*v4_mapped]]]
+ [Create an IPv4-mapped IPv6 address. ]
]
]
-[heading Protected Member Functions]
+[heading Friends]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.ip__address_v6.operator_not__eq_ [*operator!=]]]
+ [Compare two addresses for inequality. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
+ [[link boost_asio.reference.ip__address_v6.operator_lt_ [*operator<]]]
+ [Compare addresses for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.operator_lt__eq_ [*operator<=]]]
+ [Compare addresses for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.operator_eq__eq_ [*operator==]]]
+ [Compare two addresses for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.operator_gt_ [*operator>]]]
+ [Compare addresses for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__address_v6.operator_gt__eq_ [*operator>=]]]
+ [Compare addresses for ordering. ]
]
]
-[heading Protected Data Members]
+[heading Related Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ [[link boost_asio.reference.ip__address_v6.operator_lt__lt_ [*operator<<]]]
+ [Output an address as a string. ]
]
-
+
]
-The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
+The [link boost_asio.reference.ip__address_v6 `ip::address_v6`] class provides the ability to use and manipulate IP version 6 addresses.
[heading Thread Safety]
@@ -57916,238 +57907,205 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[*Header: ][^boost/asio/ip/address_v6.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:async_resolve ip::basic_resolver::async_resolve]
+[section:address_v6 ip::address_v6::address_v6]
-[indexterm2 async_resolve..ip::basic_resolver]
-Asynchronously perform forward resolution of a query to a list of entries.
+[indexterm2 address_v6..ip::address_v6]
+Default constructor.
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void ``[link boost_asio.reference.ip__basic_resolver.async_resolve.overload1 async_resolve]``(
- const query & q,
- ResolveHandler handler);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.async_resolve.overload1 more...]]``
+ ``[link boost_asio.reference.ip__address_v6.address_v6.overload1 address_v6]``();
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload1 more...]]``
-Asynchronously perform reverse resolution of an endpoint to a list of entries.
+Construct an address from raw bytes and scope ID.
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void ``[link boost_asio.reference.ip__basic_resolver.async_resolve.overload2 async_resolve]``(
- const endpoint_type & e,
- ResolveHandler handler);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.async_resolve.overload2 more...]]``
+ explicit ``[link boost_asio.reference.ip__address_v6.address_v6.overload2 address_v6]``(
+ const bytes_type & bytes,
+ unsigned long scope_id = 0);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload2 more...]]``
-[section:overload1 ip::basic_resolver::async_resolve (1 of 2 overloads)]
+Copy constructor.
-Asynchronously perform forward resolution of a query to a list of entries.
+ ``[link boost_asio.reference.ip__address_v6.address_v6.overload3 address_v6]``(
+ const address_v6 & other);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.address_v6.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void async_resolve(
- const query & q,
- ResolveHandler handler);
+[section:overload1 ip::address_v6::address_v6 (1 of 3 overloads)]
-This function is used to asynchronously resolve a query into a list of endpoint entries.
+Default constructor.
-[heading Parameters]
-
+ address_v6();
-[variablelist
-
-[[q][A query object that determines what endpoints will be returned.]]
-[[handler][The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- resolver::iterator iterator // Forward-only iterator that can
- // be used to traverse the list
- // of endpoint entries.
- );
-``
-Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
-]
+[endsect]
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
-A successful resolve operation is guaranteed to pass at least one entry to the handler.
+[section:overload2 ip::address_v6::address_v6 (2 of 3 overloads)]
-[endsect]
+Construct an address from raw bytes and scope ID.
+ address_v6(
+ const bytes_type & bytes,
+ unsigned long scope_id = 0);
-[section:overload2 ip::basic_resolver::async_resolve (2 of 2 overloads)]
-Asynchronously perform reverse resolution of an endpoint to a list of entries.
+[endsect]
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void async_resolve(
- const endpoint_type & e,
- ResolveHandler handler);
+[section:overload3 ip::address_v6::address_v6 (3 of 3 overloads)]
-This function is used to asynchronously resolve an endpoint into a list of endpoint entries.
+Copy constructor.
-[heading Parameters]
-
-[variablelist
-
-[[e][An endpoint object that determines what endpoints will be returned.]]
+ address_v6(
+ const address_v6 & other);
-[[handler][The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- resolver::iterator iterator // Forward-only iterator that can
- // be used to traverse the list
- // of endpoint entries.
- );
-``
-Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
-]
+[endsect]
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
-A successful resolve operation is guaranteed to pass at least one entry to the handler.
+[endsect]
-[endsect]
+[section:any ip::address_v6::any]
+[indexterm2 any..ip::address_v6]
+Obtain an address object that represents any address.
-[endsect]
+ static address_v6 any();
-[section:basic_resolver ip::basic_resolver::basic_resolver]
-[indexterm2 basic_resolver..ip::basic_resolver]
-Constructor.
+[endsect]
- basic_resolver(
- boost::asio::io_service & io_service);
-This constructor creates a [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`].
+[section:bytes_type ip::address_v6::bytes_type]
+[indexterm2 bytes_type..ip::address_v6]
+The type used to represent an address as an array of bytes.
-[heading Parameters]
-
-[variablelist
-
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the resolver will use to dispatch handlers for any asynchronous operations performed on the timer. ]]
+ typedef array< unsigned char, 16 > bytes_type;
-]
+[heading Remarks]
+
+This type is defined in terms of the C++0x template `std::array` when it is available. Otherwise, it uses `boost:array`.
-[endsect]
+[heading Requirements]
-[section:cancel ip::basic_resolver::cancel]
+[*Header: ][^boost/asio/ip/address_v6.hpp]
-[indexterm2 cancel..ip::basic_resolver]
-Cancel any asynchronous operations that are waiting on the resolver.
+[*Convenience header: ][^boost/asio.hpp]
- void cancel();
+[endsect]
-This function forces the completion of any pending asynchronous operations on the host resolver. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
+[section:from_string ip::address_v6::from_string]
+[indexterm2 from_string..ip::address_v6]
+Create an address from an IP address string.
-[endsect]
+ static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload1 from_string]``(
+ const char * str);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload1 more...]]``
+ static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload2 from_string]``(
+ const char * str,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload2 more...]]``
-[section:endpoint_type ip::basic_resolver::endpoint_type]
+ static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload3 from_string]``(
+ const std::string & str);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload3 more...]]``
-[indexterm2 endpoint_type..ip::basic_resolver]
-The endpoint type.
+ static address_v6 ``[link boost_asio.reference.ip__address_v6.from_string.overload4 from_string]``(
+ const std::string & str,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.from_string.overload4 more...]]``
- typedef InternetProtocol::endpoint endpoint_type;
+[section:overload1 ip::address_v6::from_string (1 of 4 overloads)]
+Create an address from an IP address string.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+ static address_v6 from_string(
+ const char * str);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:get_implementation ip::basic_resolver::get_implementation]
-[indexterm2 get_implementation..ip::basic_resolver]
-Get the underlying implementation of the I/O object.
+[section:overload2 ip::address_v6::from_string (2 of 4 overloads)]
- implementation_type & ``[link boost_asio.reference.ip__basic_resolver.get_implementation.overload1 get_implementation]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_implementation.overload1 more...]]``
+Create an address from an IP address string.
- const implementation_type & ``[link boost_asio.reference.ip__basic_resolver.get_implementation.overload2 get_implementation]``() const;
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_implementation.overload2 more...]]``
+ static address_v6 from_string(
+ const char * str,
+ boost::system::error_code & ec);
-[section:overload1 ip::basic_resolver::get_implementation (1 of 2 overloads)]
-['Inherited from basic_io_object.]
+[endsect]
-Get the underlying implementation of the I/O object.
+[section:overload3 ip::address_v6::from_string (3 of 4 overloads)]
- implementation_type & get_implementation();
+Create an address from an IP address string.
-[endsect]
+ static address_v6 from_string(
+ const std::string & str);
-[section:overload2 ip::basic_resolver::get_implementation (2 of 2 overloads)]
+[endsect]
-['Inherited from basic_io_object.]
+
+[section:overload4 ip::address_v6::from_string (4 of 4 overloads)]
-Get the underlying implementation of the I/O object.
+Create an address from an IP address string.
- const implementation_type & get_implementation() const;
+ static address_v6 from_string(
+ const std::string & str,
+ boost::system::error_code & ec);
@@ -58157,265 +58115,202 @@
[endsect]
-[section:get_io_service ip::basic_resolver::get_io_service]
+[section:is_link_local ip::address_v6::is_link_local]
+[indexterm2 is_link_local..ip::address_v6]
+Determine whether the address is link local.
-['Inherited from basic_io_object.]
-[indexterm2 get_io_service..ip::basic_resolver]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+ bool is_link_local() const;
- boost::asio::io_service & get_io_service();
+[endsect]
-This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
-[heading Return Value]
-
-A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
+[section:is_loopback ip::address_v6::is_loopback]
+[indexterm2 is_loopback..ip::address_v6]
+Determine whether the address is a loopback address.
+ bool is_loopback() const;
-[endsect]
-[section:get_service ip::basic_resolver::get_service]
+[endsect]
-[indexterm2 get_service..ip::basic_resolver]
-Get the service associated with the I/O object.
- service_type & ``[link boost_asio.reference.ip__basic_resolver.get_service.overload1 get_service]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_service.overload1 more...]]``
+[section:is_multicast ip::address_v6::is_multicast]
- const service_type & ``[link boost_asio.reference.ip__basic_resolver.get_service.overload2 get_service]``() const;
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_service.overload2 more...]]``
+[indexterm2 is_multicast..ip::address_v6]
+Determine whether the address is a multicast address.
-[section:overload1 ip::basic_resolver::get_service (1 of 2 overloads)]
+ bool is_multicast() const;
-['Inherited from basic_io_object.]
+[endsect]
-Get the service associated with the I/O object.
- service_type & get_service();
+[section:is_multicast_global ip::address_v6::is_multicast_global]
+[indexterm2 is_multicast_global..ip::address_v6]
+Determine whether the address is a global multicast address.
-[endsect]
+ bool is_multicast_global() const;
-[section:overload2 ip::basic_resolver::get_service (2 of 2 overloads)]
+[endsect]
-['Inherited from basic_io_object.]
+[section:is_multicast_link_local ip::address_v6::is_multicast_link_local]
-Get the service associated with the I/O object.
+[indexterm2 is_multicast_link_local..ip::address_v6]
+Determine whether the address is a link-local multicast address.
- const service_type & get_service() const;
+ bool is_multicast_link_local() const;
[endsect]
-[endsect]
+[section:is_multicast_node_local ip::address_v6::is_multicast_node_local]
-[section:implementation ip::basic_resolver::implementation]
+[indexterm2 is_multicast_node_local..ip::address_v6]
+Determine whether the address is a node-local multicast address.
-['Inherited from basic_io_object.]
+ bool is_multicast_node_local() const;
-[indexterm2 implementation..ip::basic_resolver]
-(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
- implementation_type implementation;
+[endsect]
-[endsect]
+[section:is_multicast_org_local ip::address_v6::is_multicast_org_local]
+[indexterm2 is_multicast_org_local..ip::address_v6]
+Determine whether the address is a org-local multicast address.
-[section:implementation_type ip::basic_resolver::implementation_type]
+ bool is_multicast_org_local() const;
-['Inherited from basic_io_object.]
-[indexterm2 implementation_type..ip::basic_resolver]
-The underlying implementation type of I/O object.
+[endsect]
- typedef service_type::implementation_type implementation_type;
+[section:is_multicast_site_local ip::address_v6::is_multicast_site_local]
+[indexterm2 is_multicast_site_local..ip::address_v6]
+Determine whether the address is a site-local multicast address.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+ bool is_multicast_site_local() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:iterator ip::basic_resolver::iterator]
+[section:is_site_local ip::address_v6::is_site_local]
-[indexterm2 iterator..ip::basic_resolver]
-The iterator type.
+[indexterm2 is_site_local..ip::address_v6]
+Determine whether the address is site local.
- typedef basic_resolver_iterator< InternetProtocol > iterator;
+ bool is_site_local() const;
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
- [The type used for the distance between two iterators. ]
-
- ]
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
- [The iterator category. ]
-
- ]
+[section:is_unspecified ip::address_v6::is_unspecified]
- [
+[indexterm2 is_unspecified..ip::address_v6]
+Determine whether the address is unspecified.
- [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
- [The type of the result of applying operator->() to the iterator. ]
-
- ]
- [
+ bool is_unspecified() const;
- [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
- [The type of the result of applying operator*() to the iterator. ]
-
- ]
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
- [The type of the value pointed to by the iterator. ]
-
- ]
+[endsect]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
- [Default constructor creates an end iterator. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
- [Create an iterator from an addrinfo list returned by getaddrinfo.
+[section:is_v4_compatible ip::address_v6::is_v4_compatible]
- Create an iterator from an endpoint, host name and service name. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
- [Dereference an iterator. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
- [Increment operator (prefix).
+[indexterm2 is_v4_compatible..ip::address_v6]
+Determine whether the address is an IPv4-compatible address.
- Increment operator (postfix). ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
- [Dereference an iterator. ]
- ]
-
-]
-[heading Friends]
-[table
- [[Name][Description]]
+ bool is_v4_compatible() const;
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
- [Test two iterators for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
- [Test two iterators for equality. ]
- ]
-
-]
-The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
-The iterator's value\_type, obtained when the iterator is dereferenced, is:
+[endsect]
- const basic_resolver_entry<InternetProtocol>
+[section:is_v4_mapped ip::address_v6::is_v4_mapped]
+[indexterm2 is_v4_mapped..ip::address_v6]
+Determine whether the address is a mapped IPv4 address.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+ bool is_v4_mapped() const;
-[*Shared] [*objects:] Unsafe.
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[section:loopback ip::address_v6::loopback]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 loopback..ip::address_v6]
+Obtain an address object that represents the loopback address.
-[endsect]
+ static address_v6 loopback();
-[section:protocol_type ip::basic_resolver::protocol_type]
+[endsect]
-[indexterm2 protocol_type..ip::basic_resolver]
-The protocol type.
- typedef InternetProtocol protocol_type;
+[section:operator_not__eq_ ip::address_v6::operator!=]
+
+[indexterm2 operator!=..ip::address_v6]
+Compare two addresses for inequality.
+ friend bool operator!=(
+ const address_v6 & a1,
+ const address_v6 & a2);
+
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[*Header: ][^boost/asio/ip/address_v6.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -58424,123 +58319,82 @@
-[section:query ip::basic_resolver::query]
+[section:operator_lt_ ip::address_v6::operator<]
-[indexterm2 query..ip::basic_resolver]
-The query type.
+[indexterm2 operator<..ip::address_v6]
+Compare addresses for ordering.
- typedef basic_resolver_query< InternetProtocol > query;
+ friend bool operator<(
+ const address_v6 & a1,
+ const address_v6 & a2);
-[heading Types]
-[table
- [[Name][Description]]
+[heading Requirements]
- [
+[*Header: ][^boost/asio/ip/address_v6.hpp]
- [[link boost_asio.reference.ip__basic_resolver_query.flags [*flags]]]
- [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
-
- ]
+[*Convenience header: ][^boost/asio.hpp]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint query. ]
-
- ]
+[endsect]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query [*basic_resolver_query]]]
- [Construct with specified service name for any protocol.
+[section:operator_lt__lt_ ip::address_v6::operator<<]
- Construct with specified service name for a given protocol.
+[indexterm2 operator<<..ip::address_v6]
+Output an address as a string.
- Construct with specified host name and service name for any protocol.
- Construct with specified host name and service name for a given protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_query.hints [*hints]]]
- [Get the hints associated with the query. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_query.host_name [*host_name]]]
- [Get the host name associated with the query. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_query.service_name [*service_name]]]
- [Get the service name associated with the query. ]
- ]
-
-]
+ template<
+ typename Elem,
+ typename Traits>
+ std::basic_ostream< Elem, Traits > & operator<<(
+ std::basic_ostream< Elem, Traits > & os,
+ const address_v6 & addr);
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.address_configured [*address_configured]]]
- [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
- ]
+Used to output a human-readable string for a specified address.
- [
- [[link boost_asio.reference.ip__basic_resolver_query.all_matching [*all_matching]]]
- [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
- ]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.canonical_name [*canonical_name]]]
- [Determine the canonical name of the host specified in the query. ]
- ]
+[heading Parameters]
+
- [
- [[link boost_asio.reference.ip__basic_resolver_query.numeric_host [*numeric_host]]]
- [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
- ]
+[variablelist
+
+[[os][The output stream to which the string will be written.]]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.numeric_service [*numeric_service]]]
- [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
- ]
+[[addr][The address to be written.]]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.passive [*passive]]]
- [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
- ]
+]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.v4_mapped [*v4_mapped]]]
- [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
- ]
-]
+[heading Return Value]
+
+The output stream.
-The [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class template describes a query that can be passed to a resolver.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[endsect]
+
+
+
+[section:operator_lt__eq_ ip::address_v6::operator<=]
+
+[indexterm2 operator<=..ip::address_v6]
+Compare addresses for ordering.
+ friend bool operator<=(
+ const address_v6 & a1,
+ const address_v6 & a2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[*Header: ][^boost/asio/ip/address_v6.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -58548,261 +58402,232 @@
[endsect]
-[section:resolve ip::basic_resolver::resolve]
-
-[indexterm2 resolve..ip::basic_resolver]
-Perform forward resolution of a query to a list of entries.
+[section:operator_eq_ ip::address_v6::operator=]
- iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload1 resolve]``(
- const query & q);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload1 more...]]``
+[indexterm2 operator=..ip::address_v6]
+Assign from another address.
- iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload2 resolve]``(
- const query & q,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload2 more...]]``
+ address_v6 & operator=(
+ const address_v6 & other);
-Perform reverse resolution of an endpoint to a list of entries.
- iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload3 resolve]``(
- const endpoint_type & e);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload3 more...]]``
+[endsect]
- iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload4 resolve]``(
- const endpoint_type & e,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload4 more...]]``
-[section:overload1 ip::basic_resolver::resolve (1 of 4 overloads)]
+[section:operator_eq__eq_ ip::address_v6::operator==]
+[indexterm2 operator==..ip::address_v6]
+Compare two addresses for equality.
-Perform forward resolution of a query to a list of entries.
+ friend bool operator==(
+ const address_v6 & a1,
+ const address_v6 & a2);
- iterator resolve(
- const query & q);
+[heading Requirements]
-This function is used to resolve a query into a list of endpoint entries.
+[*Header: ][^boost/asio/ip/address_v6.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
-[variablelist
-
-[[q][A query object that determines what endpoints will be returned.]]
+[endsect]
-]
-[heading Return Value]
-
-A forward-only iterator that can be used to traverse the list of endpoint entries.
+[section:operator_gt_ ip::address_v6::operator>]
+[indexterm2 operator>..ip::address_v6]
+Compare addresses for ordering.
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+ friend bool operator>(
+ const address_v6 & a1,
+ const address_v6 & a2);
-]
+[heading Requirements]
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
+[*Header: ][^boost/asio/ip/address_v6.hpp]
-A successful call to this function is guaranteed to return at least one entry.
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 ip::basic_resolver::resolve (2 of 4 overloads)]
-
+[section:operator_gt__eq_ ip::address_v6::operator>=]
-Perform forward resolution of a query to a list of entries.
+[indexterm2 operator>=..ip::address_v6]
+Compare addresses for ordering.
- iterator resolve(
- const query & q,
- boost::system::error_code & ec);
-
+ friend bool operator>=(
+ const address_v6 & a1,
+ const address_v6 & a2);
-This function is used to resolve a query into a list of endpoint entries.
+[heading Requirements]
-[heading Parameters]
-
+[*Header: ][^boost/asio/ip/address_v6.hpp]
-[variablelist
-
-[[q][A query object that determines what endpoints will be returned.]]
+[*Convenience header: ][^boost/asio.hpp]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[endsect]
-[heading Return Value]
-
-A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.
+[section:scope_id ip::address_v6::scope_id]
+[indexterm2 scope_id..ip::address_v6]
+The scope ID of the address.
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
-A successful call to this function is guaranteed to return at least one entry.
+ unsigned long ``[link boost_asio.reference.ip__address_v6.scope_id.overload1 scope_id]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.scope_id.overload1 more...]]``
+ void ``[link boost_asio.reference.ip__address_v6.scope_id.overload2 scope_id]``(
+ unsigned long id);
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.scope_id.overload2 more...]]``
-[endsect]
+[section:overload1 ip::address_v6::scope_id (1 of 2 overloads)]
-[section:overload3 ip::basic_resolver::resolve (3 of 4 overloads)]
+The scope ID of the address.
-Perform reverse resolution of an endpoint to a list of entries.
+ unsigned long scope_id() const;
- iterator resolve(
- const endpoint_type & e);
+Returns the scope ID associated with the IPv6 address.
-This function is used to resolve an endpoint into a list of endpoint entries.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[e][An endpoint object that determines what endpoints will be returned.]]
+[section:overload2 ip::address_v6::scope_id (2 of 2 overloads)]
-]
+The scope ID of the address.
-[heading Return Value]
-
-A forward-only iterator that can be used to traverse the list of endpoint entries.
+ void scope_id(
+ unsigned long id);
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+Modifies the scope ID associated with the IPv6 address.
-]
+[endsect]
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
-A successful call to this function is guaranteed to return at least one entry.
+[endsect]
-[endsect]
+[section:to_bytes ip::address_v6::to_bytes]
+[indexterm2 to_bytes..ip::address_v6]
+Get the address in bytes, in network byte order.
-[section:overload4 ip::basic_resolver::resolve (4 of 4 overloads)]
+ bytes_type to_bytes() const;
-Perform reverse resolution of an endpoint to a list of entries.
+[endsect]
- iterator resolve(
- const endpoint_type & e,
- boost::system::error_code & ec);
+[section:to_string ip::address_v6::to_string]
-This function is used to resolve an endpoint into a list of endpoint entries.
+[indexterm2 to_string..ip::address_v6]
+Get the address as a string.
-[heading Parameters]
-
+ std::string ``[link boost_asio.reference.ip__address_v6.to_string.overload1 to_string]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.to_string.overload1 more...]]``
-[variablelist
-
-[[e][An endpoint object that determines what endpoints will be returned.]]
+ std::string ``[link boost_asio.reference.ip__address_v6.to_string.overload2 to_string]``(
+ boost::system::error_code & ec) const;
+ `` [''''»''' [link boost_asio.reference.ip__address_v6.to_string.overload2 more...]]``
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[section:overload1 ip::address_v6::to_string (1 of 2 overloads)]
-[heading Return Value]
-
-A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.
+Get the address as a string.
-[heading Remarks]
-
-A default constructed iterator represents the end of the list.
+ std::string to_string() const;
-A successful call to this function is guaranteed to return at least one entry.
[endsect]
-[endsect]
+[section:overload2 ip::address_v6::to_string (2 of 2 overloads)]
-[section:service ip::basic_resolver::service]
+Get the address as a string.
-['Inherited from basic_io_object.]
-[indexterm2 service..ip::basic_resolver]
-(Deprecated: Use `get_service()`.) The service associated with the I/O object.
+ std::string to_string(
+ boost::system::error_code & ec) const;
- service_type & service;
+[endsect]
-[heading Remarks]
-
-Available only for services that do not support movability.
+[endsect]
+
+
+[section:to_v4 ip::address_v6::to_v4]
+
+[indexterm2 to_v4..ip::address_v6]
+Converts an IPv4-mapped or IPv4-compatible address to an IPv4 address.
+ address_v4 to_v4() const;
+
[endsect]
-[section:service_type ip::basic_resolver::service_type]
+[section:v4_compatible ip::address_v6::v4_compatible]
+[indexterm2 v4_compatible..ip::address_v6]
+Create an IPv4-compatible IPv6 address.
-['Inherited from basic_io_object.]
-[indexterm2 service_type..ip::basic_resolver]
-The type of the service that will be used to provide I/O operations.
+ static address_v6 v4_compatible(
+ const address_v4 & addr);
- typedef ResolverService service_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[section:v4_mapped ip::address_v6::v4_mapped]
+
+[indexterm2 v4_mapped..ip::address_v6]
+Create an IPv4-mapped IPv6 address.
+
+
+ static address_v6 v4_mapped(
+ const address_v4 & addr);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
@@ -58811,15 +58636,15 @@
[endsect]
-[section:ip__basic_resolver_entry ip::basic_resolver_entry]
+[section:ip__basic_endpoint ip::basic_endpoint]
-An entry produced by a resolver.
+Describes an endpoint for a version-independent IP socket.
template<
typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
- class basic_resolver_entry
+ class basic_endpoint
[heading Types]
@@ -58828,15 +58653,15 @@
[
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
- [The endpoint type associated with the endpoint entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
]
@@ -58847,78 +58672,152 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
+ [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
+ [Get the IP address associated with the endpoint.
+
+ Set the IP address associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
[Default constructor.
- Construct with specified endpoint, host name and service name. ]
+ Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
+
+ Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+
+ Copy constructor. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
- [Get the endpoint associated with the entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
- [Get the host name associated with the entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
- [Convert to the endpoint associated with the entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
- [Get the service name associated with the entry. ]
+ [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
+ [Get the port associated with the endpoint. The port number is always in the host's byte order.
+
+ Set the port associated with the endpoint. The port number is always in the host's byte order. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
]
]
-The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[*Shared] [*objects:] Unsafe.
+
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:basic_resolver_entry ip::basic_resolver_entry::basic_resolver_entry]
+[section:address ip::basic_endpoint::address]
-[indexterm2 basic_resolver_entry..ip::basic_resolver_entry]
-Default constructor.
+[indexterm2 address..ip::basic_endpoint]
+Get the IP address associated with the endpoint.
- ``[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload1 basic_resolver_entry]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload1 more...]]``
+ boost::asio::ip::address ``[link boost_asio.reference.ip__basic_endpoint.address.overload1 address]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.address.overload1 more...]]``
-Construct with specified endpoint, host name and service name.
+Set the IP address associated with the endpoint.
- ``[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload2 basic_resolver_entry]``(
- const endpoint_type & ep,
- const std::string & host,
- const std::string & service);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload2 more...]]``
+ void ``[link boost_asio.reference.ip__basic_endpoint.address.overload2 address]``(
+ const boost::asio::ip::address & addr);
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.address.overload2 more...]]``
-[section:overload1 ip::basic_resolver_entry::basic_resolver_entry (1 of 2 overloads)]
+[section:overload1 ip::basic_endpoint::address (1 of 2 overloads)]
-Default constructor.
+Get the IP address associated with the endpoint.
- basic_resolver_entry();
+ boost::asio::ip::address address() const;
@@ -58926,16 +58825,14 @@
-[section:overload2 ip::basic_resolver_entry::basic_resolver_entry (2 of 2 overloads)]
+[section:overload2 ip::basic_endpoint::address (2 of 2 overloads)]
-Construct with specified endpoint, host name and service name.
+Set the IP address associated with the endpoint.
- basic_resolver_entry(
- const endpoint_type & ep,
- const std::string & host,
- const std::string & service);
+ void address(
+ const boost::asio::ip::address & addr);
@@ -58944,341 +58841,294 @@
[endsect]
+[section:basic_endpoint ip::basic_endpoint::basic_endpoint]
-[section:endpoint ip::basic_resolver_entry::endpoint]
+[indexterm2 basic_endpoint..ip::basic_endpoint]
+Default constructor.
-[indexterm2 endpoint..ip::basic_resolver_entry]
-Get the endpoint associated with the entry.
+
+ ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload1 basic_endpoint]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload1 more...]]``
- endpoint_type endpoint() const;
+Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR\_ANY or in6addr\_any). This constructor would typically be used for accepting new connections.
+ ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload2 basic_endpoint]``(
+ const InternetProtocol & internet_protocol,
+ unsigned short port_num);
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload2 more...]]``
-[endsect]
+Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
-[section:endpoint_type ip::basic_resolver_entry::endpoint_type]
+ ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload3 basic_endpoint]``(
+ const boost::asio::ip::address & addr,
+ unsigned short port_num);
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload3 more...]]``
-[indexterm2 endpoint_type..ip::basic_resolver_entry]
-The endpoint type associated with the endpoint entry.
+Copy constructor.
- typedef InternetProtocol::endpoint endpoint_type;
+ ``[link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload4 basic_endpoint]``(
+ const basic_endpoint & other);
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.basic_endpoint.overload4 more...]]``
-[heading Requirements]
+[section:overload1 ip::basic_endpoint::basic_endpoint (1 of 4 overloads)]
-[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+Default constructor.
+
+
+ basic_endpoint();
+
[endsect]
-[section:host_name ip::basic_resolver_entry::host_name]
+[section:overload2 ip::basic_endpoint::basic_endpoint (2 of 4 overloads)]
-[indexterm2 host_name..ip::basic_resolver_entry]
-Get the host name associated with the entry.
+Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR\_ANY or in6addr\_any). This constructor would typically be used for accepting new connections.
- std::string host_name() const;
+ basic_endpoint(
+ const InternetProtocol & internet_protocol,
+ unsigned short port_num);
-[endsect]
+[heading Examples]
+
+To initialise an IPv4 TCP endpoint for port 1234, use:
+ boost::asio::ip::tcp::endpoint ep(boost::asio::ip::tcp::v4(), 1234);
-[section:operator_endpoint_type ip::basic_resolver_entry::operator endpoint_type]
-[indexterm2 operator endpoint_type..ip::basic_resolver_entry]
-Convert to the endpoint associated with the entry.
- operator endpoint_type() const;
+To specify an IPv6 UDP endpoint for port 9876, use:
+ boost::asio::ip::udp::endpoint ep(boost::asio::ip::udp::v6(), 9876);
-[endsect]
-[section:protocol_type ip::basic_resolver_entry::protocol_type]
+[endsect]
-[indexterm2 protocol_type..ip::basic_resolver_entry]
-The protocol type associated with the endpoint entry.
- typedef InternetProtocol protocol_type;
+[section:overload3 ip::basic_endpoint::basic_endpoint (3 of 4 overloads)]
+Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
+ basic_endpoint(
+ const boost::asio::ip::address & addr,
+ unsigned short port_num);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:service_name ip::basic_resolver_entry::service_name]
+[section:overload4 ip::basic_endpoint::basic_endpoint (4 of 4 overloads)]
-[indexterm2 service_name..ip::basic_resolver_entry]
-Get the service name associated with the entry.
+Copy constructor.
- std::string service_name() const;
+
+ basic_endpoint(
+ const basic_endpoint & other);
[endsect]
-
[endsect]
-[section:ip__basic_resolver_iterator ip::basic_resolver_iterator]
+[section:capacity ip::basic_endpoint::capacity]
-An iterator over the entries produced by a resolver.
+[indexterm2 capacity..ip::basic_endpoint]
+Get the capacity of the endpoint in the native type.
- template<
- typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
- class basic_resolver_iterator
+ std::size_t capacity() const;
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
- [The type used for the distance between two iterators. ]
-
- ]
- [
+[section:data ip::basic_endpoint::data]
- [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
- [The iterator category. ]
-
- ]
+[indexterm2 data..ip::basic_endpoint]
+Get the underlying endpoint in the native type.
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
- [The type of the result of applying operator->() to the iterator. ]
-
- ]
+ data_type * ``[link boost_asio.reference.ip__basic_endpoint.data.overload1 data]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.data.overload1 more...]]``
- [
+ const data_type * ``[link boost_asio.reference.ip__basic_endpoint.data.overload2 data]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.data.overload2 more...]]``
- [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
- [The type of the result of applying operator*() to the iterator. ]
-
- ]
- [
+[section:overload1 ip::basic_endpoint::data (1 of 2 overloads)]
- [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
- [The type of the value pointed to by the iterator. ]
-
- ]
-]
+Get the underlying endpoint in the native type.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
- [Default constructor creates an end iterator. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
- [Create an iterator from an addrinfo list returned by getaddrinfo.
+ data_type * data();
- Create an iterator from an endpoint, host name and service name. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
- [Dereference an iterator. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
- [Increment operator (prefix).
- Increment operator (postfix). ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
- [Dereference an iterator. ]
- ]
-
-]
-[heading Friends]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
- [Test two iterators for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
- [Test two iterators for equality. ]
- ]
-
-]
-The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
-The iterator's value\_type, obtained when the iterator is dereferenced, is:
+[section:overload2 ip::basic_endpoint::data (2 of 2 overloads)]
- const basic_resolver_entry<InternetProtocol>
+Get the underlying endpoint in the native type.
+ const data_type * data() const;
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[endsect]
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[section:data_type ip::basic_endpoint::data_type]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 data_type..ip::basic_endpoint]
+The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer.
-[section:basic_resolver_iterator ip::basic_resolver_iterator::basic_resolver_iterator]
+ typedef implementation_defined data_type;
-[indexterm2 basic_resolver_iterator..ip::basic_resolver_iterator]
-Default constructor creates an end iterator.
- basic_resolver_iterator();
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:create ip::basic_resolver_iterator::create]
-[indexterm2 create..ip::basic_resolver_iterator]
-Create an iterator from an addrinfo list returned by getaddrinfo.
+[section:operator_not__eq_ ip::basic_endpoint::operator!=]
+[indexterm2 operator!=..ip::basic_endpoint]
+Compare two endpoints for inequality.
- static basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.create.overload1 create]``(
- boost::asio::detail::addrinfo_type * address_info,
- const std::string & host_name,
- const std::string & service_name);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload1 more...]]``
+ friend bool operator!=(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
-Create an iterator from an endpoint, host name and service name.
+[heading Requirements]
- static basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.create.overload2 create]``(
- const typename InternetProtocol::endpoint & endpoint,
- const std::string & host_name,
- const std::string & service_name);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload2 more...]]``
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload1 ip::basic_resolver_iterator::create (1 of 2 overloads)]
+[endsect]
-Create an iterator from an addrinfo list returned by getaddrinfo.
- static basic_resolver_iterator create(
- boost::asio::detail::addrinfo_type * address_info,
- const std::string & host_name,
- const std::string & service_name);
+[section:operator_lt_ ip::basic_endpoint::operator<]
+[indexterm2 operator<..ip::basic_endpoint]
+Compare endpoints for ordering.
-[endsect]
+ friend bool operator<(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
+[heading Requirements]
-[section:overload2 ip::basic_resolver_iterator::create (2 of 2 overloads)]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-Create an iterator from an endpoint, host name and service name.
+[endsect]
- static basic_resolver_iterator create(
- const typename InternetProtocol::endpoint & endpoint,
- const std::string & host_name,
- const std::string & service_name);
+[section:operator_lt__lt_ ip::basic_endpoint::operator<<]
-[endsect]
+[indexterm2 operator<<..ip::basic_endpoint]
+Output an endpoint as a string.
-[endsect]
+ std::basic_ostream< Elem, Traits > & operator<<(
+ std::basic_ostream< Elem, Traits > & os,
+ const basic_endpoint< InternetProtocol > & endpoint);
-[section:difference_type ip::basic_resolver_iterator::difference_type]
+Used to output a human-readable string for a specified endpoint.
-[indexterm2 difference_type..ip::basic_resolver_iterator]
-The type used for the distance between two iterators.
+[heading Parameters]
+
- typedef std::ptrdiff_t difference_type;
+[variablelist
+
+[[os][The output stream to which the string will be written.]]
+[[endpoint][The endpoint to be written.]]
+]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[heading Return Value]
+
+The output stream.
-[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[endsect]
-[section:iterator_category ip::basic_resolver_iterator::iterator_category]
-[indexterm2 iterator_category..ip::basic_resolver_iterator]
-The iterator category.
+[section:operator_lt__eq_ ip::basic_endpoint::operator<=]
+[indexterm2 operator<=..ip::basic_endpoint]
+Compare endpoints for ordering.
- typedef std::forward_iterator_tag iterator_category;
+ friend bool operator<=(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -59287,13 +59137,14 @@
-[section:operator__star_ ip::basic_resolver_iterator::operator *]
+[section:operator_eq_ ip::basic_endpoint::operator=]
-[indexterm2 operator *..ip::basic_resolver_iterator]
-Dereference an iterator.
+[indexterm2 operator=..ip::basic_endpoint]
+Assign from another endpoint.
- const basic_resolver_entry< InternetProtocol > & operator *() const;
+ basic_endpoint & operator=(
+ const basic_endpoint & other);
@@ -59301,20 +59152,20 @@
-[section:operator_not__eq_ ip::basic_resolver_iterator::operator!=]
+[section:operator_eq__eq_ ip::basic_endpoint::operator==]
-[indexterm2 operator!=..ip::basic_resolver_iterator]
-Test two iterators for inequality.
+[indexterm2 operator==..ip::basic_endpoint]
+Compare two endpoints for equality.
- friend bool operator!=(
- const basic_resolver_iterator & a,
- const basic_resolver_iterator & b);
+ friend bool operator==(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -59322,204 +59173,176 @@
[endsect]
-[section:operator_plus__plus_ ip::basic_resolver_iterator::operator++]
-[indexterm2 operator++..ip::basic_resolver_iterator]
-Increment operator (prefix).
+[section:operator_gt_ ip::basic_endpoint::operator>]
+[indexterm2 operator>..ip::basic_endpoint]
+Compare endpoints for ordering.
- basic_resolver_iterator & ``[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload1 operator++]``();
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload1 more...]]``
+ friend bool operator>(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
-Increment operator (postfix).
+[heading Requirements]
- basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload2 operator++]``(
- int );
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload2 more...]]``
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload1 ip::basic_resolver_iterator::operator++ (1 of 2 overloads)]
+[endsect]
-Increment operator (prefix).
- basic_resolver_iterator & operator++();
+[section:operator_gt__eq_ ip::basic_endpoint::operator>=]
+[indexterm2 operator>=..ip::basic_endpoint]
+Compare endpoints for ordering.
-[endsect]
+ friend bool operator>=(
+ const basic_endpoint< InternetProtocol > & e1,
+ const basic_endpoint< InternetProtocol > & e2);
+
+[heading Requirements]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[section:overload2 ip::basic_resolver_iterator::operator++ (2 of 2 overloads)]
+[*Convenience header: ][^boost/asio.hpp]
-Increment operator (postfix).
+[endsect]
- basic_resolver_iterator operator++(
- int );
+[section:port ip::basic_endpoint::port]
+[indexterm2 port..ip::basic_endpoint]
+Get the port associated with the endpoint. The port number is always in the host's byte order.
-[endsect]
+ unsigned short ``[link boost_asio.reference.ip__basic_endpoint.port.overload1 port]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.port.overload1 more...]]``
-[endsect]
+Set the port associated with the endpoint. The port number is always in the host's byte order.
-[section:operator_arrow_ ip::basic_resolver_iterator::operator->]
+ void ``[link boost_asio.reference.ip__basic_endpoint.port.overload2 port]``(
+ unsigned short port_num);
+ `` [''''»''' [link boost_asio.reference.ip__basic_endpoint.port.overload2 more...]]``
-[indexterm2 operator->..ip::basic_resolver_iterator]
-Dereference an iterator.
+[section:overload1 ip::basic_endpoint::port (1 of 2 overloads)]
- const basic_resolver_entry< InternetProtocol > * operator->() const;
+Get the port associated with the endpoint. The port number is always in the host's byte order.
-[endsect]
+ unsigned short port() const;
-[section:operator_eq__eq_ ip::basic_resolver_iterator::operator==]
+[endsect]
-[indexterm2 operator==..ip::basic_resolver_iterator]
-Test two iterators for equality.
- friend bool operator==(
- const basic_resolver_iterator & a,
- const basic_resolver_iterator & b);
+[section:overload2 ip::basic_endpoint::port (2 of 2 overloads)]
-[heading Requirements]
+Set the port associated with the endpoint. The port number is always in the host's byte order.
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ void port(
+ unsigned short port_num);
+
[endsect]
+[endsect]
-[section:pointer ip::basic_resolver_iterator::pointer]
-[indexterm2 pointer..ip::basic_resolver_iterator]
-The type of the result of applying `operator->()` to the iterator.
+[section:protocol ip::basic_endpoint::protocol]
+[indexterm2 protocol..ip::basic_endpoint]
+The protocol associated with the endpoint.
- typedef const basic_resolver_entry< InternetProtocol > * pointer;
+ protocol_type protocol() const;
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:protocol_type ip::basic_endpoint::protocol_type]
+[indexterm2 protocol_type..ip::basic_endpoint]
+The protocol type associated with the endpoint.
-[section:reference ip::basic_resolver_iterator::reference]
+ typedef InternetProtocol protocol_type;
-[indexterm2 reference..ip::basic_resolver_iterator]
-The type of the result of applying `operator*()` to the iterator.
- typedef const basic_resolver_entry< InternetProtocol > & reference;
+[heading Requirements]
+[*Header: ][^boost/asio/ip/basic_endpoint.hpp]
-[heading Types]
-[table
- [[Name][Description]]
+[*Convenience header: ][^boost/asio.hpp]
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
- [The endpoint type associated with the endpoint entry. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint entry. ]
-
- ]
-]
+[section:resize ip::basic_endpoint::resize]
-[heading Member Functions]
-[table
- [[Name][Description]]
+[indexterm2 resize..ip::basic_endpoint]
+Set the underlying size of the endpoint in the native type.
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
- [Default constructor.
- Construct with specified endpoint, host name and service name. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
- [Get the endpoint associated with the entry. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
- [Get the host name associated with the entry. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
- [Convert to the endpoint associated with the entry. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
- [Get the service name associated with the entry. ]
- ]
-
-]
+ void resize(
+ std::size_t new_size);
-The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[endsect]
-[*Shared] [*objects:] Unsafe.
+[section:size ip::basic_endpoint::size]
+[indexterm2 size..ip::basic_endpoint]
+Get the underlying size of the endpoint in the native type.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+ std::size_t size() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:value_type ip::basic_resolver_iterator::value_type]
+[endsect]
-[indexterm2 value_type..ip::basic_resolver_iterator]
-The type of the value pointed to by the iterator.
+[section:ip__basic_resolver ip::basic_resolver]
- typedef basic_resolver_entry< InternetProtocol > value_type;
+Provides endpoint resolution functionality.
+
+
+ template<
+ typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``,
+ typename ``[link boost_asio.reference.ResolverService ResolverService]`` = resolver_service<InternetProtocol>>
+ class basic_resolver :
+ public basic_io_object< ResolverService >
[heading Types]
@@ -59528,105 +59351,43 @@
[
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
- [The endpoint type associated with the endpoint entry. ]
+ [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint entry. ]
+ [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
]
-]
-
-[heading Member Functions]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
- [Default constructor.
- Construct with specified endpoint, host name and service name. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
- [Get the endpoint associated with the entry. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
- [Get the host name associated with the entry. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
- [Convert to the endpoint associated with the entry. ]
- ]
+ [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
+ [The iterator type. ]
- [
- [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
- [Get the service name associated with the entry. ]
]
-
-]
-
-The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
+ [
-[heading Thread Safety]
+ [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
+ [The protocol type. ]
-[*Distinct] [*objects:] Safe.
-
-[*Shared] [*objects:] Unsafe.
-
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[endsect]
-
-[section:ip__basic_resolver_query ip::basic_resolver_query]
-
-
-An query to be passed to a resolver.
-
-
- template<
- typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
- class basic_resolver_query :
- public ip::resolver_query_base
-
-
-[heading Types]
-[table
- [[Name][Description]]
+ ]
[
- [[link boost_asio.reference.ip__basic_resolver_query.flags [*flags]]]
- [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
+ [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
+ [The query type. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_query.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint query. ]
+ [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
]
@@ -59637,75 +59398,69 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query [*basic_resolver_query]]]
- [Construct with specified service name for any protocol.
-
- Construct with specified service name for a given protocol.
-
- Construct with specified host name and service name for any protocol.
+ [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
+ [Asynchronously perform forward resolution of a query to a list of entries.
- Construct with specified host name and service name for a given protocol. ]
+ Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_query.hints [*hints]]]
- [Get the hints associated with the query. ]
+ [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
+ [Constructor. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_query.host_name [*host_name]]]
- [Get the host name associated with the query. ]
+ [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the resolver. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_query.service_name [*service_name]]]
- [Get the service name associated with the query. ]
+ [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
+ [Perform forward resolution of a query to a list of entries.
+
+ Perform reverse resolution of an endpoint to a list of entries. ]
]
]
-[heading Data Members]
+[heading Protected Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver_query.address_configured [*address_configured]]]
- [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_query.all_matching [*all_matching]]]
- [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_query.canonical_name [*canonical_name]]]
- [Determine the canonical name of the host specified in the query. ]
+ [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_resolver_query.numeric_host [*numeric_host]]]
- [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
+ [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
]
+
+]
- [
- [[link boost_asio.reference.ip__basic_resolver_query.numeric_service [*numeric_service]]]
- [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
- ]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver_query.passive [*passive]]]
- [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_query.v4_mapped [*v4_mapped]]]
- [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
+ [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
]
]
-The [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class template describes a query that can be passed to a resolver.
+The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
[heading Thread Safety]
@@ -59718,99 +59473,97 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
[*Convenience header: ][^boost/asio.hpp]
+[section:async_resolve ip::basic_resolver::async_resolve]
-[section:address_configured ip::basic_resolver_query::address_configured]
+[indexterm2 async_resolve..ip::basic_resolver]
+Asynchronously perform forward resolution of a query to a list of entries.
-['Inherited from ip::resolver_query_base.]
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void ``[link boost_asio.reference.ip__basic_resolver.async_resolve.overload1 async_resolve]``(
+ const query & q,
+ ResolveHandler handler);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.async_resolve.overload1 more...]]``
-[indexterm2 address_configured..ip::basic_resolver_query]
-Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system.
+Asynchronously perform reverse resolution of an endpoint to a list of entries.
- static const flags address_configured = implementation_defined;
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void ``[link boost_asio.reference.ip__basic_resolver.async_resolve.overload2 async_resolve]``(
+ const endpoint_type & e,
+ ResolveHandler handler);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.async_resolve.overload2 more...]]``
-[endsect]
+[section:overload1 ip::basic_resolver::async_resolve (1 of 2 overloads)]
+Asynchronously perform forward resolution of a query to a list of entries.
-[section:all_matching ip::basic_resolver_query::all_matching]
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void async_resolve(
+ const query & q,
+ ResolveHandler handler);
-['Inherited from ip::resolver_query_base.]
-[indexterm2 all_matching..ip::basic_resolver_query]
-If used with v4\_mapped, return all matching IPv6 and IPv4 addresses.
+This function is used to asynchronously resolve a query into a list of endpoint entries.
- static const flags all_matching = implementation_defined;
+[heading Parameters]
+
+[variablelist
+
+[[q][A query object that determines what endpoints will be returned.]]
+[[handler][The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ resolver::iterator iterator // Forward-only iterator that can
+ // be used to traverse the list
+ // of endpoint entries.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
-[endsect]
+]
-[section:basic_resolver_query ip::basic_resolver_query::basic_resolver_query]
+[heading Remarks]
+
+A default constructed iterator represents the end of the list.
-[indexterm2 basic_resolver_query..ip::basic_resolver_query]
-Construct with specified service name for any protocol.
+A successful resolve operation is guaranteed to pass at least one entry to the handler.
- ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload1 basic_resolver_query]``(
- const std::string & service,
- resolver_query_base::flags resolve_flags = passive|address_configured);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload1 more...]]``
+[endsect]
-Construct with specified service name for a given protocol.
-
- ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload2 basic_resolver_query]``(
- const protocol_type & protocol,
- const std::string & service,
- resolver_query_base::flags resolve_flags = passive|address_configured);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload2 more...]]``
-
-
-Construct with specified host name and service name for any protocol.
-
-
- ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload3 basic_resolver_query]``(
- const std::string & host,
- const std::string & service,
- resolver_query_base::flags resolve_flags = address_configured);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload3 more...]]``
-
-
-Construct with specified host name and service name for a given protocol.
-
-
- ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload4 basic_resolver_query]``(
- const protocol_type & protocol,
- const std::string & host,
- const std::string & service,
- resolver_query_base::flags resolve_flags = address_configured);
- `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload4 more...]]``
-
-
-[section:overload1 ip::basic_resolver_query::basic_resolver_query (1 of 4 overloads)]
+[section:overload2 ip::basic_resolver::async_resolve (2 of 2 overloads)]
-Construct with specified service name for any protocol.
+Asynchronously perform reverse resolution of an endpoint to a list of entries.
- basic_resolver_query(
- const std::string & service,
- resolver_query_base::flags resolve_flags = passive|address_configured);
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void async_resolve(
+ const endpoint_type & e,
+ ResolveHandler handler);
-This constructor is typically used to perform name resolution for local service binding.
+This function is used to asynchronously resolve an endpoint into a list of endpoint entries.
[heading Parameters]
@@ -59818,37 +59571,46 @@
[variablelist
-[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.]]
+[[e][An endpoint object that determines what endpoints will be returned.]]
-[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for local service binding.]]
+[[handler][The handler to be called when the resolve operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ resolver::iterator iterator // Forward-only iterator that can
+ // be used to traverse the list
+ // of endpoint entries.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
]
[heading Remarks]
-On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
-
+A default constructed iterator represents the end of the list.
+A successful resolve operation is guaranteed to pass at least one entry to the handler.
[endsect]
+[endsect]
-[section:overload2 ip::basic_resolver_query::basic_resolver_query (2 of 4 overloads)]
+[section:basic_resolver ip::basic_resolver::basic_resolver]
-Construct with specified service name for a given protocol.
+[indexterm2 basic_resolver..ip::basic_resolver]
+Constructor.
- basic_resolver_query(
- const protocol_type & protocol,
- const std::string & service,
- resolver_query_base::flags resolve_flags = passive|address_configured);
+ basic_resolver(
+ boost::asio::io_service & io_service);
-This constructor is typically used to perform name resolution for local service binding with a specific protocol version.
+This constructor creates a [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`].
[heading Parameters]
@@ -59856,121 +59618,76 @@
[variablelist
-[[protocol][A protocol object, normally representing either the IPv4 or IPv6 version of an internet protocol.]]
-
-[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.]]
-
-[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for local service binding.]]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the resolver will use to dispatch handlers for any asynchronous operations performed on the timer. ]]
]
-[heading Remarks]
-
-On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
-
-
[endsect]
-[section:overload3 ip::basic_resolver_query::basic_resolver_query (3 of 4 overloads)]
-
-
-Construct with specified host name and service name for any protocol.
-
-
- basic_resolver_query(
- const std::string & host,
- const std::string & service,
- resolver_query_base::flags resolve_flags = address_configured);
-
-
-This constructor is typically used to perform name resolution for communication with remote hosts.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[host][A string identifying a location. May be a descriptive name or a numeric address string. If an empty string and the passive flag has been specified, the resolved endpoints are suitable for local service binding. If an empty string and passive is not specified, the resolved endpoints will use the loopback address.]]
-
-[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number. May be an empty string, in which case all resolved endpoints will have a port number of 0.]]
+[section:cancel ip::basic_resolver::cancel]
-[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for communication with remote hosts.]]
+[indexterm2 cancel..ip::basic_resolver]
+Cancel any asynchronous operations that are waiting on the resolver.
-]
+ void cancel();
-[heading Remarks]
-
-On POSIX systems, host names may be locally defined in the file `/etc/hosts`. On Windows, host names may be defined in the file `c:\windows\system32\drivers\etc\hosts`. Remote host name resolution is performed using DNS. Operating systems may use additional locations when resolving host names (such as NETBIOS names on Windows).
-On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
+This function forces the completion of any pending asynchronous operations on the host resolver. The handler for each cancelled operation will be invoked with the `boost::asio::error::operation_aborted` error code.
[endsect]
-[section:overload4 ip::basic_resolver_query::basic_resolver_query (4 of 4 overloads)]
-
-
-Construct with specified host name and service name for a given protocol.
-
+[section:endpoint_type ip::basic_resolver::endpoint_type]
- basic_resolver_query(
- const protocol_type & protocol,
- const std::string & host,
- const std::string & service,
- resolver_query_base::flags resolve_flags = address_configured);
+[indexterm2 endpoint_type..ip::basic_resolver]
+The endpoint type.
-This constructor is typically used to perform name resolution for communication with remote hosts.
+ typedef InternetProtocol::endpoint endpoint_type;
-[heading Parameters]
-
-[variablelist
-
-[[protocol][A protocol object, normally representing either the IPv4 or IPv6 version of an internet protocol.]]
+[heading Requirements]
-[[host][A string identifying a location. May be a descriptive name or a numeric address string. If an empty string and the passive flag has been specified, the resolved endpoints are suitable for local service binding. If an empty string and passive is not specified, the resolved endpoints will use the loopback address.]]
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
-[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number. May be an empty string, in which case all resolved endpoints will have a port number of 0.]]
+[*Convenience header: ][^boost/asio.hpp]
-[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for communication with remote hosts.]]
-]
+[endsect]
-[heading Remarks]
-
-On POSIX systems, host names may be locally defined in the file `/etc/hosts`. On Windows, host names may be defined in the file `c:\windows\system32\drivers\etc\hosts`. Remote host name resolution is performed using DNS. Operating systems may use additional locations when resolving host names (such as NETBIOS names on Windows).
+[section:get_implementation ip::basic_resolver::get_implementation]
-On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
+[indexterm2 get_implementation..ip::basic_resolver]
+Get the underlying implementation of the I/O object.
-[endsect]
+ implementation_type & ``[link boost_asio.reference.ip__basic_resolver.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_implementation.overload1 more...]]``
+ const implementation_type & ``[link boost_asio.reference.ip__basic_resolver.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_implementation.overload2 more...]]``
-[endsect]
+[section:overload1 ip::basic_resolver::get_implementation (1 of 2 overloads)]
-[section:canonical_name ip::basic_resolver_query::canonical_name]
+['Inherited from basic_io_object.]
-['Inherited from ip::resolver_query_base.]
-[indexterm2 canonical_name..ip::basic_resolver_query]
-Determine the canonical name of the host specified in the query.
+Get the underlying implementation of the I/O object.
- static const flags canonical_name = implementation_defined;
+ implementation_type & get_implementation();
@@ -59978,102 +59695,73 @@
-[section:flags ip::basic_resolver_query::flags]
-
-
-['Inherited from ip::resolver_query_base.]
-
-[indexterm2 flags..ip::basic_resolver_query]
-A bitmask type (C++ Std [lib.bitmask.types]).
+[section:overload2 ip::basic_resolver::get_implementation (2 of 2 overloads)]
- typedef unspecified flags;
+['Inherited from basic_io_object.]
+Get the underlying implementation of the I/O object.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
+ const implementation_type & get_implementation() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:hints ip::basic_resolver_query::hints]
-
-[indexterm2 hints..ip::basic_resolver_query]
-Get the hints associated with the query.
-
-
- const boost::asio::detail::addrinfo_type & hints() const;
-
-
-
[endsect]
-
-[section:host_name ip::basic_resolver_query::host_name]
-
-[indexterm2 host_name..ip::basic_resolver_query]
-Get the host name associated with the query.
-
-
- std::string host_name() const;
-
+[section:get_io_service ip::basic_resolver::get_io_service]
-[endsect]
+['Inherited from basic_io_object.]
+[indexterm2 get_io_service..ip::basic_resolver]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
-[section:numeric_host ip::basic_resolver_query::numeric_host]
+ boost::asio::io_service & get_io_service();
-['Inherited from ip::resolver_query_base.]
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
-[indexterm2 numeric_host..ip::basic_resolver_query]
-Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
- static const flags numeric_host = implementation_defined;
[endsect]
+[section:get_service ip::basic_resolver::get_service]
-[section:numeric_service ip::basic_resolver_query::numeric_service]
-
-
-['Inherited from ip::resolver_query_base.]
-
-[indexterm2 numeric_service..ip::basic_resolver_query]
-Service name should be treated as a numeric string defining a port number and no name resolution should be attempted.
-
-
- static const flags numeric_service = implementation_defined;
+[indexterm2 get_service..ip::basic_resolver]
+Get the service associated with the I/O object.
+ service_type & ``[link boost_asio.reference.ip__basic_resolver.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_service.overload1 more...]]``
-[endsect]
+ const service_type & ``[link boost_asio.reference.ip__basic_resolver.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.get_service.overload2 more...]]``
+[section:overload1 ip::basic_resolver::get_service (1 of 2 overloads)]
-[section:passive ip::basic_resolver_query::passive]
+['Inherited from basic_io_object.]
-['Inherited from ip::resolver_query_base.]
-[indexterm2 passive..ip::basic_resolver_query]
-Indicate that returned endpoint is intended for use as a locally bound socket endpoint.
+Get the service associated with the I/O object.
- static const flags passive = implementation_defined;
+ service_type & get_service();
@@ -60081,141 +59769,111 @@
-[section:protocol_type ip::basic_resolver_query::protocol_type]
-
-[indexterm2 protocol_type..ip::basic_resolver_query]
-The protocol type associated with the endpoint query.
+[section:overload2 ip::basic_resolver::get_service (2 of 2 overloads)]
- typedef InternetProtocol protocol_type;
+['Inherited from basic_io_object.]
+Get the service associated with the I/O object.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
+ const service_type & get_service() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:service_name ip::basic_resolver_query::service_name]
-
-[indexterm2 service_name..ip::basic_resolver_query]
-Get the service name associated with the query.
-
-
- std::string service_name() const;
-
-
-
[endsect]
-
-[section:v4_mapped ip::basic_resolver_query::v4_mapped]
-
-
-['Inherited from ip::resolver_query_base.]
-
-[indexterm2 v4_mapped..ip::basic_resolver_query]
-If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses.
+[section:implementation ip::basic_resolver::implementation]
- static const flags v4_mapped = implementation_defined;
+['Inherited from basic_io_object.]
+[indexterm2 implementation..ip::basic_resolver]
+(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
-[endsect]
+ implementation_type implementation;
[endsect]
-[section:ip__host_name ip::host_name]
-
-[indexterm1 ip::host_name]
-Get the current host name.
-
- std::string ``[link boost_asio.reference.ip__host_name.overload1 host_name]``();
- `` [''''»''' [link boost_asio.reference.ip__host_name.overload1 more...]]``
- std::string ``[link boost_asio.reference.ip__host_name.overload2 host_name]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__host_name.overload2 more...]]``
+[section:implementation_type ip::basic_resolver::implementation_type]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/host_name.hpp]
+['Inherited from basic_io_object.]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 implementation_type..ip::basic_resolver]
+The underlying implementation type of I/O object.
-[section:overload1 ip::host_name (1 of 2 overloads)]
+ typedef service_type::implementation_type implementation_type;
-Get the current host name.
+[heading Requirements]
- std::string host_name();
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 ip::host_name (2 of 2 overloads)]
-
-
-Get the current host name.
-
-
- std::string host_name(
- boost::system::error_code & ec);
-
-
-
-[endsect]
+[section:iterator ip::basic_resolver::iterator]
+[indexterm2 iterator..ip::basic_resolver]
+The iterator type.
-[endsect]
-[section:ip__icmp ip::icmp]
+ typedef basic_resolver_iterator< InternetProtocol > iterator;
-Encapsulates the flags needed for ICMP.
+[heading Types]
+[table
+ [[Name][Description]]
+ [
- class icmp
+ [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
+ [The type used for the distance between two iterators. ]
+
+ ]
+ [
-[heading Types]
-[table
- [[Name][Description]]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
+ [The iterator category. ]
+
+ ]
[
- [[link boost_asio.reference.ip__icmp.endpoint [*endpoint]]]
- [The type of a ICMP endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
+ [The type of the result of applying operator->() to the iterator. ]
]
[
- [[link boost_asio.reference.ip__icmp.resolver [*resolver]]]
- [The ICMP resolver type. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
+ [The type of the result of applying operator*() to the iterator. ]
]
[
- [[link boost_asio.reference.ip__icmp.socket [*socket]]]
- [The ICMP socket type. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
+ [The type of the value pointed to by the iterator. ]
]
@@ -60226,28 +59884,32 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__icmp.family [*family]]]
- [Obtain an identifier for the protocol family. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
+ [Default constructor creates an end iterator. ]
]
[
- [[link boost_asio.reference.ip__icmp.protocol [*protocol]]]
- [Obtain an identifier for the protocol. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
+ [Create an iterator from an addrinfo list returned by getaddrinfo.
+
+ Create an iterator from an endpoint, host name and service name. ]
]
[
- [[link boost_asio.reference.ip__icmp.type [*type]]]
- [Obtain an identifier for the type of the protocol. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
+ [Dereference an iterator. ]
]
[
- [[link boost_asio.reference.ip__icmp.v4 [*v4]]]
- [Construct to represent the IPv4 ICMP protocol. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
+ [Increment operator (prefix).
+
+ Increment operator (postfix). ]
]
[
- [[link boost_asio.reference.ip__icmp.v6 [*v6]]]
- [Construct to represent the IPv6 ICMP protocol. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
+ [Dereference an iterator. ]
]
]
@@ -60257,43 +59919,75 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__icmp.operator_not__eq_ [*operator!=]]]
- [Compare two protocols for inequality. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
+ [Test two iterators for inequality. ]
]
[
- [[link boost_asio.reference.ip__icmp.operator_eq__eq_ [*operator==]]]
- [Compare two protocols for equality. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
+ [Test two iterators for equality. ]
]
]
-The [link boost_asio.reference.ip__icmp `ip::icmp`] class contains flags necessary for ICMP sockets.
+The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
+
+The iterator's value\_type, obtained when the iterator is dereferenced, is:
+
+ const basic_resolver_entry<InternetProtocol>
+
+
+
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/icmp.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:endpoint ip::icmp::endpoint]
+[endsect]
-[indexterm2 endpoint..ip::icmp]
-The type of a ICMP endpoint.
- typedef basic_endpoint< icmp > endpoint;
+[section:protocol_type ip::basic_resolver::protocol_type]
+
+[indexterm2 protocol_type..ip::basic_resolver]
+The protocol type.
+
+
+ typedef InternetProtocol protocol_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:query ip::basic_resolver::query]
+
+[indexterm2 query..ip::basic_resolver]
+The query type.
+
+
+ typedef basic_resolver_query< InternetProtocol > query;
[heading Types]
@@ -60302,15 +59996,15 @@
[
- [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.flags [*flags]]]
+ [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint query. ]
]
@@ -60321,125 +60015,89 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
- [Get the IP address associated with the endpoint.
-
- Set the IP address associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
- [Default constructor.
-
- Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
+ [[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query [*basic_resolver_query]]]
+ [Construct with specified service name for any protocol.
- Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+ Construct with specified service name for a given protocol.
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
- [Get the port associated with the endpoint. The port number is always in the host's byte order.
+ Construct with specified host name and service name for any protocol.
- Set the port associated with the endpoint. The port number is always in the host's byte order. ]
+ Construct with specified host name and service name for a given protocol. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.hints [*hints]]]
+ [Get the hints associated with the query. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.host_name [*host_name]]]
+ [Get the host name associated with the query. ]
]
[
- [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.service_name [*service_name]]]
+ [Get the service name associated with the query. ]
]
]
-[heading Friends]
+[heading Data Members]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.address_configured [*address_configured]]]
+ [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.all_matching [*all_matching]]]
+ [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.canonical_name [*canonical_name]]]
+ [Determine the canonical name of the host specified in the query. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.numeric_host [*numeric_host]]]
+ [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.numeric_service [*numeric_service]]]
+ [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.passive [*passive]]]
+ [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
]
-
-]
-
-[heading Related Functions]
-[table
- [[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.v4_mapped [*v4_mapped]]]
+ [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
]
-
+
]
-The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
+The [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class template describes a query that can be passed to a resolver.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
-
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/icmp.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -60447,390 +60105,295 @@
[endsect]
+[section:resolve ip::basic_resolver::resolve]
-[section:family ip::icmp::family]
+[indexterm2 resolve..ip::basic_resolver]
+Perform forward resolution of a query to a list of entries.
-[indexterm2 family..ip::icmp]
-Obtain an identifier for the protocol family.
+ iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload1 resolve]``(
+ const query & q);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload1 more...]]``
- int family() const;
+ iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload2 resolve]``(
+ const query & q,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload2 more...]]``
+Perform reverse resolution of an endpoint to a list of entries.
-[endsect]
+ iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload3 resolve]``(
+ const endpoint_type & e);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload3 more...]]``
+ iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload4 resolve]``(
+ const endpoint_type & e,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver.resolve.overload4 more...]]``
-[section:operator_not__eq_ ip::icmp::operator!=]
-[indexterm2 operator!=..ip::icmp]
-Compare two protocols for inequality.
+[section:overload1 ip::basic_resolver::resolve (1 of 4 overloads)]
- friend bool operator!=(
- const icmp & p1,
- const icmp & p2);
+Perform forward resolution of a query to a list of entries.
-[heading Requirements]
+ iterator resolve(
+ const query & q);
-[*Header: ][^boost/asio/ip/icmp.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+This function is used to resolve a query into a list of endpoint entries.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[q][A query object that determines what endpoints will be returned.]]
+]
-[section:operator_eq__eq_ ip::icmp::operator==]
-[indexterm2 operator==..ip::icmp]
-Compare two protocols for equality.
+[heading Return Value]
+
+A forward-only iterator that can be used to traverse the list of endpoint entries.
- friend bool operator==(
- const icmp & p1,
- const icmp & p2);
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/ip/icmp.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Remarks]
+
+A default constructed iterator represents the end of the list.
+
+A successful call to this function is guaranteed to return at least one entry.
[endsect]
-[section:protocol ip::icmp::protocol]
+[section:overload2 ip::basic_resolver::resolve (2 of 4 overloads)]
-[indexterm2 protocol..ip::icmp]
-Obtain an identifier for the protocol.
+Perform forward resolution of a query to a list of entries.
- int protocol() const;
+ iterator resolve(
+ const query & q,
+ boost::system::error_code & ec);
-[endsect]
+This function is used to resolve a query into a list of endpoint entries.
+[heading Parameters]
+
-[section:resolver ip::icmp::resolver]
+[variablelist
+
+[[q][A query object that determines what endpoints will be returned.]]
-[indexterm2 resolver..ip::icmp]
-The ICMP resolver type.
+[[ec][Set to indicate what error occurred, if any.]]
+]
- typedef basic_resolver< icmp > resolver;
+[heading Return Value]
+
+A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.
-[heading Types]
-[table
- [[Name][Description]]
- [
+[heading Remarks]
+
+A default constructed iterator represents the end of the list.
- [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
+A successful call to this function is guaranteed to return at least one entry.
- [
- [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
- [The iterator type. ]
-
- ]
- [
+[section:overload3 ip::basic_resolver::resolve (3 of 4 overloads)]
- [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
- [
+Perform reverse resolution of an endpoint to a list of entries.
- [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
- [The query type. ]
-
- ]
- [
+ iterator resolve(
+ const endpoint_type & e);
- [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
-]
+This function is used to resolve an endpoint into a list of endpoint entries.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously perform forward resolution of a query to a list of entries.
+[heading Parameters]
+
- Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
- [Constructor. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
- [Cancel any asynchronous operations that are waiting on the resolver. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
+[variablelist
- [
- [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Perform forward resolution of a query to a list of entries.
+[[e][An endpoint object that determines what endpoints will be returned.]]
- Perform reverse resolution of an endpoint to a list of entries. ]
- ]
-
]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
+[heading Return Value]
+
+A forward-only iterator that can be used to traverse the list of endpoint entries.
+
+
+[heading Exceptions]
+
+
+[variablelist
+[[boost::system::system_error][Thrown on failure.]]
+
]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
+[heading Remarks]
+
+A default constructed iterator represents the end of the list.
- [
- [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
+A successful call to this function is guaranteed to return at least one entry.
-]
-The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
+[endsect]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[section:overload4 ip::basic_resolver::resolve (4 of 4 overloads)]
+Perform reverse resolution of an endpoint to a list of entries.
-[heading Requirements]
+ iterator resolve(
+ const endpoint_type & e,
+ boost::system::error_code & ec);
-[*Header: ][^boost/asio/ip/icmp.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+This function is used to resolve an endpoint into a list of endpoint entries.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[e][An endpoint object that determines what endpoints will be returned.]]
+[[ec][Set to indicate what error occurred, if any.]]
-[section:socket ip::icmp::socket]
+]
-[indexterm2 socket..ip::icmp]
-The ICMP socket type.
+[heading Return Value]
+
+A forward-only iterator that can be used to traverse the list of endpoint entries. Returns a default constructed iterator if an error occurs.
- typedef basic_raw_socket< icmp > socket;
+[heading Remarks]
+
+A default constructed iterator represents the end of the list.
-[heading Types]
-[table
- [[Name][Description]]
+A successful call to this function is guaranteed to return at least one entry.
- [
- [[link boost_asio.reference.basic_raw_socket.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_raw_socket.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_raw_socket.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
+[section:service ip::basic_resolver::service]
- [
- [[link boost_asio.reference.basic_raw_socket.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
+['Inherited from basic_io_object.]
- [
+[indexterm2 service..ip::basic_resolver]
+(Deprecated: Use `get_service()`.) The service associated with the I/O object.
- [[link boost_asio.reference.basic_raw_socket.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
+ service_type & service;
- [[link boost_asio.reference.basic_raw_socket.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[heading Remarks]
+
+Available only for services that do not support movability.
- [
- [[link boost_asio.reference.basic_raw_socket.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_raw_socket.lowest_layer_type [*lowest_layer_type]]]
- [A basic_socket is always the lowest layer. ]
-
- ]
- [
+[section:service_type ip::basic_resolver::service_type]
- [[link boost_asio.reference.basic_raw_socket.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
- [
+['Inherited from basic_io_object.]
- [[link boost_asio.reference.basic_raw_socket.native_handle_type [*native_handle_type]]]
- [The native representation of a socket. ]
-
- ]
+[indexterm2 service_type..ip::basic_resolver]
+The type of the service that will be used to provide I/O operations.
- [
- [[link boost_asio.reference.basic_raw_socket.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
-
- ]
+ typedef ResolverService service_type;
- [
- [[link boost_asio.reference.basic_raw_socket.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
- [
+[heading Requirements]
- [[link boost_asio.reference.basic_raw_socket.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+[*Header: ][^boost/asio/ip/basic_resolver.hpp]
- [
+[*Convenience header: ][^boost/asio.hpp]
- [[link boost_asio.reference.basic_raw_socket.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_raw_socket.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
+[endsect]
- [
+[section:ip__basic_resolver_entry ip::basic_resolver_entry]
- [[link boost_asio.reference.basic_raw_socket.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
- [
+An entry produced by a resolver.
- [[link boost_asio.reference.basic_raw_socket.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
+
+ template<
+ typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
+ class basic_resolver_entry
+
+
+[heading Types]
+[table
+ [[Name][Description]]
[
- [[link boost_asio.reference.basic_raw_socket.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
+ [The endpoint type associated with the endpoint entry. ]
]
[
- [[link boost_asio.reference.basic_raw_socket.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint entry. ]
]
@@ -60841,355 +60404,180 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_raw_socket.assign [*assign]]]
- [Assign an existing native socket to the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.async_receive [*async_receive]]]
- [Start an asynchronous receive on a connected socket. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
+ [Default constructor.
+
+ Construct with specified endpoint, host name and service name. ]
]
[
- [[link boost_asio.reference.basic_raw_socket.async_receive_from [*async_receive_from]]]
- [Start an asynchronous receive. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
+ [Get the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.basic_raw_socket.async_send [*async_send]]]
- [Start an asynchronous send on a connected socket. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
+ [Get the host name associated with the entry. ]
]
[
- [[link boost_asio.reference.basic_raw_socket.async_send_to [*async_send_to]]]
- [Start an asynchronous send. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
+ [Convert to the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.basic_raw_socket.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
+ [Get the service name associated with the entry. ]
]
- [
- [[link boost_asio.reference.basic_raw_socket.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
+]
+
+The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
+
+
+[heading Thread Safety]
- [
- [[link boost_asio.reference.basic_raw_socket.basic_raw_socket [*basic_raw_socket]]]
- [Construct a basic_raw_socket without opening it.
+[*Distinct] [*objects:] Safe.
- Construct and open a basic_raw_socket.
+[*Shared] [*objects:] Unsafe.
- Construct a basic_raw_socket, opening it and binding it to the given local endpoint.
- Construct a basic_raw_socket on an existing native socket.
- Move-construct a basic_raw_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.bind [*bind]]]
- [Bind the socket to the given local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.close [*close]]]
- [Close the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.connect [*connect]]]
- [Connect the socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.get_option [*get_option]]]
- [Get an option from the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
-
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.native_handle [*native_handle]]]
- [Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
-
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
-
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.open [*open]]]
- [Open the socket using the specified protocol. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.operator_eq_ [*operator=]]]
- [Move-assign a basic_raw_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.receive [*receive]]]
- [Receive some data on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.receive_from [*receive_from]]]
- [Receive raw data with the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.send [*send]]]
- [Send some data on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.send_to [*send_to]]]
- [Send raw data to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.set_option [*set_option]]]
- [Set an option on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
-]
+[heading Requirements]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
- [
- [[link boost_asio.reference.basic_raw_socket.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_raw_socket.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Data Members]
-[table
- [[Name][Description]]
+[section:basic_resolver_entry ip::basic_resolver_entry::basic_resolver_entry]
- [
- [[link boost_asio.reference.basic_raw_socket.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
+[indexterm2 basic_resolver_entry..ip::basic_resolver_entry]
+Default constructor.
- [
- [[link boost_asio.reference.basic_raw_socket.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
+ ``[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload1 basic_resolver_entry]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload1 more...]]``
- [
- [[link boost_asio.reference.basic_raw_socket.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
- ]
+Construct with specified endpoint, host name and service name.
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+ ``[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload2 basic_resolver_entry]``(
+ const endpoint_type & ep,
+ const std::string & host,
+ const std::string & service);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry.overload2 more...]]``
- [
- [[link boost_asio.reference.basic_raw_socket.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
- [
- [[link boost_asio.reference.basic_raw_socket.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
+[section:overload1 ip::basic_resolver_entry::basic_resolver_entry (1 of 2 overloads)]
-]
-The [link boost_asio.reference.basic_raw_socket `basic_raw_socket`] class template provides asynchronous and blocking raw-oriented socket functionality.
+Default constructor.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+ basic_resolver_entry();
-[*Shared] [*objects:] Unsafe.
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/icmp.hpp]
+[section:overload2 ip::basic_resolver_entry::basic_resolver_entry (2 of 2 overloads)]
-[*Convenience header: ][^boost/asio.hpp]
+Construct with specified endpoint, host name and service name.
-[endsect]
+ basic_resolver_entry(
+ const endpoint_type & ep,
+ const std::string & host,
+ const std::string & service);
-[section:type ip::icmp::type]
-[indexterm2 type..ip::icmp]
-Obtain an identifier for the type of the protocol.
+[endsect]
- int type() const;
+[endsect]
+[section:endpoint ip::basic_resolver_entry::endpoint]
-[endsect]
+[indexterm2 endpoint..ip::basic_resolver_entry]
+Get the endpoint associated with the entry.
+ endpoint_type endpoint() const;
-[section:v4 ip::icmp::v4]
-[indexterm2 v4..ip::icmp]
-Construct to represent the IPv4 ICMP protocol.
+[endsect]
- static icmp v4();
+[section:endpoint_type ip::basic_resolver_entry::endpoint_type]
-[endsect]
+[indexterm2 endpoint_type..ip::basic_resolver_entry]
+The endpoint type associated with the endpoint entry.
+ typedef InternetProtocol::endpoint endpoint_type;
-[section:v6 ip::icmp::v6]
-[indexterm2 v6..ip::icmp]
-Construct to represent the IPv6 ICMP protocol.
+[heading Requirements]
- static icmp v6();
+[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
+[section:host_name ip::basic_resolver_entry::host_name]
+[indexterm2 host_name..ip::basic_resolver_entry]
+Get the host name associated with the entry.
-[section:ip__multicast__enable_loopback ip::multicast::enable_loopback]
-[indexterm1 ip::multicast::enable_loopback]
-Socket option determining whether outgoing multicast packets will be received on the same socket if it is a member of the multicast group.
+ std::string host_name() const;
- typedef implementation_defined enable_loopback;
+[endsect]
-Implements the IPPROTO\_IP/IP\_MULTICAST\_LOOP socket option.
+[section:operator_endpoint_type ip::basic_resolver_entry::operator endpoint_type]
-[heading Examples]
-
-Setting the option:
+[indexterm2 operator endpoint_type..ip::basic_resolver_entry]
+Convert to the endpoint associated with the entry.
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::multicast::enable_loopback option(true);
- socket.set_option(option);
+ operator endpoint_type() const;
+[endsect]
-Getting the current option value:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::multicast::enable_loopback option;
- socket.get_option(option);
- bool is_set = option.value();
+[section:protocol_type ip::basic_resolver_entry::protocol_type]
+[indexterm2 protocol_type..ip::basic_resolver_entry]
+The protocol type associated with the endpoint entry.
+ typedef InternetProtocol protocol_type;
[heading Requirements]
-[*Header: ][^boost/asio/ip/multicast.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_entry.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -61198,172 +60586,235 @@
-[section:ip__multicast__hops ip::multicast::hops]
+[section:service_name ip::basic_resolver_entry::service_name]
-[indexterm1 ip::multicast::hops]
-Socket option for time-to-live associated with outgoing multicast packets.
+[indexterm2 service_name..ip::basic_resolver_entry]
+Get the service name associated with the entry.
- typedef implementation_defined hops;
+ std::string service_name() const;
-Implements the IPPROTO\_IP/IP\_MULTICAST\_TTL socket option.
+[endsect]
-[heading Examples]
-
-Setting the option:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::multicast::hops option(4);
- socket.set_option(option);
+[endsect]
+[section:ip__basic_resolver_iterator ip::basic_resolver_iterator]
+An iterator over the entries produced by a resolver.
-Getting the current option value:
+ template<
+ typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
+ class basic_resolver_iterator
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::multicast::hops option;
- socket.get_option(option);
- int ttl = option.value();
+[heading Types]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
+ [The type used for the distance between two iterators. ]
+
+ ]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
+ [The iterator category. ]
+
+ ]
+ [
-[heading Requirements]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
+ [The type of the result of applying operator->() to the iterator. ]
+
+ ]
-[*Header: ][^boost/asio/ip/multicast.hpp]
+ [
-[*Convenience header: ][^boost/asio.hpp]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
+ [The type of the result of applying operator*() to the iterator. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
+ [The type of the value pointed to by the iterator. ]
+
+ ]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[section:ip__multicast__join_group ip::multicast::join_group]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
+ [Default constructor creates an end iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
+ [Create an iterator from an addrinfo list returned by getaddrinfo.
-[indexterm1 ip::multicast::join_group]
-Socket option to join a multicast group on a specified interface.
+ Create an iterator from an endpoint, host name and service name. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
+ [Dereference an iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
+ [Increment operator (prefix).
+ Increment operator (postfix). ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
+ [Dereference an iterator. ]
+ ]
+
+]
- typedef implementation_defined join_group;
+[heading Friends]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
+ [Test two iterators for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
+ [Test two iterators for equality. ]
+ ]
+
+]
+The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
-Implements the IPPROTO\_IP/IP\_ADD\_MEMBERSHIP socket option.
+The iterator's value\_type, obtained when the iterator is dereferenced, is:
+ const basic_resolver_entry<InternetProtocol>
-[heading Examples]
-
-Setting the option to join a multicast group:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::address multicast_address =
- boost::asio::ip::address::from_string("225.0.0.1");
- boost::asio::ip::multicast::join_group option(multicast_address);
- socket.set_option(option);
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/multicast.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:basic_resolver_iterator ip::basic_resolver_iterator::basic_resolver_iterator]
+[indexterm2 basic_resolver_iterator..ip::basic_resolver_iterator]
+Default constructor creates an end iterator.
-[section:ip__multicast__leave_group ip::multicast::leave_group]
+ basic_resolver_iterator();
-[indexterm1 ip::multicast::leave_group]
-Socket option to leave a multicast group on a specified interface.
- typedef implementation_defined leave_group;
+[endsect]
+[section:create ip::basic_resolver_iterator::create]
-Implements the IPPROTO\_IP/IP\_DROP\_MEMBERSHIP socket option.
+[indexterm2 create..ip::basic_resolver_iterator]
+Create an iterator from an addrinfo list returned by getaddrinfo.
-[heading Examples]
-
-Setting the option to leave a multicast group:
+ static basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.create.overload1 create]``(
+ boost::asio::detail::addrinfo_type * address_info,
+ const std::string & host_name,
+ const std::string & service_name);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload1 more...]]``
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::address multicast_address =
- boost::asio::ip::address::from_string("225.0.0.1");
- boost::asio::ip::multicast::leave_group option(multicast_address);
- socket.set_option(option);
+
+Create an iterator from an endpoint, host name and service name.
+ static basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.create.overload2 create]``(
+ const typename InternetProtocol::endpoint & endpoint,
+ const std::string & host_name,
+ const std::string & service_name);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.create.overload2 more...]]``
+[section:overload1 ip::basic_resolver_iterator::create (1 of 2 overloads)]
+Create an iterator from an addrinfo list returned by getaddrinfo.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/multicast.hpp]
+ static basic_resolver_iterator create(
+ boost::asio::detail::addrinfo_type * address_info,
+ const std::string & host_name,
+ const std::string & service_name);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:ip__multicast__outbound_interface ip::multicast::outbound_interface]
+[section:overload2 ip::basic_resolver_iterator::create (2 of 2 overloads)]
-[indexterm1 ip::multicast::outbound_interface]
-Socket option for local interface to use for outgoing multicast packets.
+Create an iterator from an endpoint, host name and service name.
- typedef implementation_defined outbound_interface;
+ static basic_resolver_iterator create(
+ const typename InternetProtocol::endpoint & endpoint,
+ const std::string & host_name,
+ const std::string & service_name);
-Implements the IPPROTO\_IP/IP\_MULTICAST\_IF socket option.
+[endsect]
-[heading Examples]
-
-Setting the option:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::address_v4 local_interface =
- boost::asio::ip::address_v4::from_string("1.2.3.4");
- boost::asio::ip::multicast::outbound_interface option(local_interface);
- socket.set_option(option);
+[endsect]
+
+[section:difference_type ip::basic_resolver_iterator::difference_type]
+[indexterm2 difference_type..ip::basic_resolver_iterator]
+The type used for the distance between two iterators.
+ typedef std::ptrdiff_t difference_type;
[heading Requirements]
-[*Header: ][^boost/asio/ip/multicast.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -61371,122 +60822,88 @@
[endsect]
-[section:ip__resolver_query_base ip::resolver_query_base]
+[section:iterator_category ip::basic_resolver_iterator::iterator_category]
-The [link boost_asio.reference.ip__resolver_query_base `ip::resolver_query_base`] class is used as a base for the [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class templates to provide a common place to define the flag constants.
+[indexterm2 iterator_category..ip::basic_resolver_iterator]
+The iterator category.
- class resolver_query_base
+ typedef std::forward_iterator_tag iterator_category;
-[heading Types]
-[table
- [[Name][Description]]
- [
+[heading Requirements]
- [[link boost_asio.reference.ip__resolver_query_base.flags [*flags]]]
- [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
-
- ]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
-]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__resolver_query_base._resolver_query_base [*~resolver_query_base]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
-]
+[endsect]
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__resolver_query_base.address_configured [*address_configured]]]
- [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
- ]
- [
- [[link boost_asio.reference.ip__resolver_query_base.all_matching [*all_matching]]]
- [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
- ]
+[section:operator__star_ ip::basic_resolver_iterator::operator *]
- [
- [[link boost_asio.reference.ip__resolver_query_base.canonical_name [*canonical_name]]]
- [Determine the canonical name of the host specified in the query. ]
- ]
+[indexterm2 operator *..ip::basic_resolver_iterator]
+Dereference an iterator.
- [
- [[link boost_asio.reference.ip__resolver_query_base.numeric_host [*numeric_host]]]
- [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
- ]
- [
- [[link boost_asio.reference.ip__resolver_query_base.numeric_service [*numeric_service]]]
- [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
- ]
+ const basic_resolver_entry< InternetProtocol > & operator *() const;
- [
- [[link boost_asio.reference.ip__resolver_query_base.passive [*passive]]]
- [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
- ]
- [
- [[link boost_asio.reference.ip__resolver_query_base.v4_mapped [*v4_mapped]]]
- [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
- ]
-]
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ip/resolver_query_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:operator_not__eq_ ip::basic_resolver_iterator::operator!=]
+[indexterm2 operator!=..ip::basic_resolver_iterator]
+Test two iterators for inequality.
-[section:address_configured ip::resolver_query_base::address_configured]
-[indexterm2 address_configured..ip::resolver_query_base]
-Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system.
+ friend bool operator!=(
+ const basic_resolver_iterator & a,
+ const basic_resolver_iterator & b);
- static const flags address_configured = implementation_defined;
+[heading Requirements]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:operator_plus__plus_ ip::basic_resolver_iterator::operator++]
-[section:all_matching ip::resolver_query_base::all_matching]
+[indexterm2 operator++..ip::basic_resolver_iterator]
+Increment operator (prefix).
-[indexterm2 all_matching..ip::resolver_query_base]
-If used with v4\_mapped, return all matching IPv6 and IPv4 addresses.
+ basic_resolver_iterator & ``[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload1 operator++]``();
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload1 more...]]``
- static const flags all_matching = implementation_defined;
+Increment operator (postfix).
-[endsect]
+ basic_resolver_iterator ``[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload2 operator++]``(
+ int );
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_.overload2 more...]]``
+[section:overload1 ip::basic_resolver_iterator::operator++ (1 of 2 overloads)]
-[section:canonical_name ip::resolver_query_base::canonical_name]
-[indexterm2 canonical_name..ip::resolver_query_base]
-Determine the canonical name of the host specified in the query.
+Increment operator (prefix).
- static const flags canonical_name = implementation_defined;
+ basic_resolver_iterator & operator++();
@@ -61494,48 +60911,30 @@
-[section:flags ip::resolver_query_base::flags]
-
-[indexterm2 flags..ip::resolver_query_base]
-A bitmask type (C++ Std [lib.bitmask.types]).
-
-
- typedef unspecified flags;
+[section:overload2 ip::basic_resolver_iterator::operator++ (2 of 2 overloads)]
+Increment operator (postfix).
-[heading Requirements]
-[*Header: ][^boost/asio/ip/resolver_query_base.hpp]
+ basic_resolver_iterator operator++(
+ int );
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:numeric_host ip::resolver_query_base::numeric_host]
-
-[indexterm2 numeric_host..ip::resolver_query_base]
-Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.
-
-
- static const flags numeric_host = implementation_defined;
-
-
-
[endsect]
+[section:operator_arrow_ ip::basic_resolver_iterator::operator->]
-[section:numeric_service ip::resolver_query_base::numeric_service]
-
-[indexterm2 numeric_service..ip::resolver_query_base]
-Service name should be treated as a numeric string defining a port number and no name resolution should be attempted.
+[indexterm2 operator->..ip::basic_resolver_iterator]
+Dereference an iterator.
- static const flags numeric_service = implementation_defined;
+ const basic_resolver_entry< InternetProtocol > * operator->() const;
@@ -61543,60 +60942,56 @@
-[section:passive ip::resolver_query_base::passive]
-
-[indexterm2 passive..ip::resolver_query_base]
-Indicate that returned endpoint is intended for use as a locally bound socket endpoint.
-
+[section:operator_eq__eq_ ip::basic_resolver_iterator::operator==]
- static const flags passive = implementation_defined;
+[indexterm2 operator==..ip::basic_resolver_iterator]
+Test two iterators for equality.
+ friend bool operator==(
+ const basic_resolver_iterator & a,
+ const basic_resolver_iterator & b);
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
-[section:v4_mapped ip::resolver_query_base::v4_mapped]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 v4_mapped..ip::resolver_query_base]
-If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses.
+[endsect]
- static const flags v4_mapped = implementation_defined;
+[section:pointer ip::basic_resolver_iterator::pointer]
-[endsect]
+[indexterm2 pointer..ip::basic_resolver_iterator]
+The type of the result of applying `operator->()` to the iterator.
+ typedef const basic_resolver_entry< InternetProtocol > * pointer;
-[section:_resolver_query_base ip::resolver_query_base::~resolver_query_base]
-[indexterm2 ~resolver_query_base..ip::resolver_query_base]
-Protected destructor to prevent deletion through this type.
+[heading Requirements]
- ~resolver_query_base();
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
-
-[section:ip__resolver_service ip::resolver_service]
-
+[section:reference ip::basic_resolver_iterator::reference]
-Default service implementation for a resolver.
+[indexterm2 reference..ip::basic_resolver_iterator]
+The type of the result of applying `operator*()` to the iterator.
- template<
- typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
- class resolver_service :
- public io_service::service
+ typedef const basic_resolver_entry< InternetProtocol > & reference;
[heading Types]
@@ -61605,36 +61000,15 @@
[
- [[link boost_asio.reference.ip__resolver_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__resolver_service.implementation_type [*implementation_type]]]
- [The type of a resolver implementation. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__resolver_service.iterator_type [*iterator_type]]]
- [The iterator type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__resolver_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
+ [The endpoint type associated with the endpoint entry. ]
]
[
- [[link boost_asio.reference.ip__resolver_service.query_type [*query_type]]]
- [The query type. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint entry. ]
]
@@ -61645,240 +61019,49 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__resolver_service.async_resolve [*async_resolve]]]
- [Asynchronously resolve a query to a list of entries.
+ [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
+ [Default constructor.
- Asynchronously resolve an endpoint to a list of entries. ]
- ]
-
- [
- [[link boost_asio.reference.ip__resolver_service.cancel [*cancel]]]
- [Cancel pending asynchronous operations. ]
- ]
-
- [
- [[link boost_asio.reference.ip__resolver_service.construct [*construct]]]
- [Construct a new resolver implementation. ]
+ Construct with specified endpoint, host name and service name. ]
]
[
- [[link boost_asio.reference.ip__resolver_service.destroy [*destroy]]]
- [Destroy a resolver implementation. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
+ [Get the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.ip__resolver_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
+ [Get the host name associated with the entry. ]
]
[
- [[link boost_asio.reference.ip__resolver_service.resolve [*resolve]]]
- [Resolve a query to a list of entries.
-
- Resolve an endpoint to a list of entries. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
+ [Convert to the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.ip__resolver_service.resolver_service [*resolver_service]]]
- [Construct a new resolver service for the specified io_service. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
+ [Get the service name associated with the entry. ]
]
]
-[heading Data Members]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.ip__resolver_service.id [*id]]]
- [The unique service identifier. ]
- ]
-
-]
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-[section:async_resolve ip::resolver_service::async_resolve]
-
-[indexterm2 async_resolve..ip::resolver_service]
-Asynchronously resolve a query to a list of entries.
-
-
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void ``[link boost_asio.reference.ip__resolver_service.async_resolve.overload1 async_resolve]``(
- implementation_type & impl,
- const query_type & query,
- ResolveHandler handler);
- `` [''''»''' [link boost_asio.reference.ip__resolver_service.async_resolve.overload1 more...]]``
-
-
-Asynchronously resolve an endpoint to a list of entries.
-
-
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void ``[link boost_asio.reference.ip__resolver_service.async_resolve.overload2 async_resolve]``(
- implementation_type & impl,
- const endpoint_type & endpoint,
- ResolveHandler handler);
- `` [''''»''' [link boost_asio.reference.ip__resolver_service.async_resolve.overload2 more...]]``
-
-
-[section:overload1 ip::resolver_service::async_resolve (1 of 2 overloads)]
-
-
-Asynchronously resolve a query to a list of entries.
-
-
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void async_resolve(
- implementation_type & impl,
- const query_type & query,
- ResolveHandler handler);
-
-
-
-[endsect]
-
-
-
-[section:overload2 ip::resolver_service::async_resolve (2 of 2 overloads)]
-
-
-Asynchronously resolve an endpoint to a list of entries.
-
-
- template<
- typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
- void async_resolve(
- implementation_type & impl,
- const endpoint_type & endpoint,
- ResolveHandler handler);
-
-
-
-[endsect]
-
-
-[endsect]
-
-
-[section:cancel ip::resolver_service::cancel]
-
-[indexterm2 cancel..ip::resolver_service]
-Cancel pending asynchronous operations.
-
-
- void cancel(
- implementation_type & impl);
-
-
-
-[endsect]
-
-
-
-[section:construct ip::resolver_service::construct]
-
-[indexterm2 construct..ip::resolver_service]
-Construct a new resolver implementation.
-
-
- void construct(
- implementation_type & impl);
-
-
-
-[endsect]
-
-
-
-[section:destroy ip::resolver_service::destroy]
-
-[indexterm2 destroy..ip::resolver_service]
-Destroy a resolver implementation.
-
-
- void destroy(
- implementation_type & impl);
-
-
-
-[endsect]
-
-
-
-[section:endpoint_type ip::resolver_service::endpoint_type]
-
-[indexterm2 endpoint_type..ip::resolver_service]
-The endpoint type.
-
-
- typedef InternetProtocol::endpoint endpoint_type;
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[section:get_io_service ip::resolver_service::get_io_service]
-
-
-['Inherited from io_service.]
-
-[indexterm2 get_io_service..ip::resolver_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-
-
- boost::asio::io_service & get_io_service();
-
-
-
-[endsect]
-
-
-
-[section:id ip::resolver_service::id]
-
-[indexterm2 id..ip::resolver_service]
-The unique service identifier.
-
-
- static boost::asio::io_service::id id;
-
-
-
-[endsect]
-
-
+The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
-[section:implementation_type ip::resolver_service::implementation_type]
-[indexterm2 implementation_type..ip::resolver_service]
-The type of a resolver implementation.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
- typedef implementation_defined implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -61887,13 +61070,13 @@
-[section:iterator_type ip::resolver_service::iterator_type]
+[section:value_type ip::basic_resolver_iterator::value_type]
-[indexterm2 iterator_type..ip::resolver_service]
-The iterator type.
+[indexterm2 value_type..ip::basic_resolver_iterator]
+The type of the value pointed to by the iterator.
- typedef basic_resolver_iterator< InternetProtocol > iterator_type;
+ typedef basic_resolver_entry< InternetProtocol > value_type;
[heading Types]
@@ -61902,36 +61085,15 @@
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
- [The type used for the distance between two iterators. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
- [The iterator category. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
- [The type of the result of applying operator->() to the iterator. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
- [The type of the result of applying operator*() to the iterator. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint_type [*endpoint_type]]]
+ [The endpoint type associated with the endpoint entry. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
- [The type of the value pointed to by the iterator. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint entry. ]
]
@@ -61942,60 +61104,35 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
- [Default constructor creates an end iterator. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
- [Create an iterator from an addrinfo list returned by getaddrinfo.
+ [[link boost_asio.reference.ip__basic_resolver_entry.basic_resolver_entry [*basic_resolver_entry]]]
+ [Default constructor.
- Create an iterator from an endpoint, host name and service name. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
- [Dereference an iterator. ]
+ Construct with specified endpoint, host name and service name. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
- [Increment operator (prefix).
-
- Increment operator (postfix). ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.endpoint [*endpoint]]]
+ [Get the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
- [Dereference an iterator. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.host_name [*host_name]]]
+ [Get the host name associated with the entry. ]
]
-]
-
-[heading Friends]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
- [Test two iterators for inequality. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.operator_endpoint_type [*operator endpoint_type]]]
+ [Convert to the endpoint associated with the entry. ]
]
[
- [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
- [Test two iterators for equality. ]
+ [[link boost_asio.reference.ip__basic_resolver_entry.service_name [*service_name]]]
+ [Get the service name associated with the entry. ]
]
]
-The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
-
-The iterator's value\_type, obtained when the iterator is dereferenced, is:
-
- const basic_resolver_entry<InternetProtocol>
-
-
-
+The [link boost_asio.reference.ip__basic_resolver_entry `ip::basic_resolver_entry`] class template describes an entry as returned by a resolver.
[heading Thread Safety]
@@ -62009,7 +61146,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_iterator.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -62018,34 +61155,18 @@
-[section:protocol_type ip::resolver_service::protocol_type]
-
-[indexterm2 protocol_type..ip::resolver_service]
-The protocol type.
-
-
- typedef InternetProtocol protocol_type;
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
[endsect]
+[section:ip__basic_resolver_query ip::basic_resolver_query]
-[section:query_type ip::resolver_service::query_type]
-
-[indexterm2 query_type..ip::resolver_service]
-The query type.
+An query to be passed to a resolver.
- typedef basic_resolver_query< InternetProtocol > query_type;
+ template<
+ typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
+ class basic_resolver_query :
+ public ip::resolver_query_base
[heading Types]
@@ -62152,591 +61273,384 @@
-
[heading Requirements]
-[*Header: ][^boost/asio/ip/resolver_service.hpp]
+[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:address_configured ip::basic_resolver_query::address_configured]
-[section:resolve ip::resolver_service::resolve]
+['Inherited from ip::resolver_query_base.]
-[indexterm2 resolve..ip::resolver_service]
-Resolve a query to a list of entries.
+[indexterm2 address_configured..ip::basic_resolver_query]
+Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system.
- iterator_type ``[link boost_asio.reference.ip__resolver_service.resolve.overload1 resolve]``(
- implementation_type & impl,
- const query_type & query,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__resolver_service.resolve.overload1 more...]]``
+ static const flags address_configured = implementation_defined;
-Resolve an endpoint to a list of entries.
+[endsect]
- iterator_type ``[link boost_asio.reference.ip__resolver_service.resolve.overload2 resolve]``(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ip__resolver_service.resolve.overload2 more...]]``
-[section:overload1 ip::resolver_service::resolve (1 of 2 overloads)]
+[section:all_matching ip::basic_resolver_query::all_matching]
-Resolve a query to a list of entries.
+['Inherited from ip::resolver_query_base.]
+[indexterm2 all_matching..ip::basic_resolver_query]
+If used with v4\_mapped, return all matching IPv6 and IPv4 addresses.
- iterator_type resolve(
- implementation_type & impl,
- const query_type & query,
- boost::system::error_code & ec);
+ static const flags all_matching = implementation_defined;
-[endsect]
+[endsect]
-[section:overload2 ip::resolver_service::resolve (2 of 2 overloads)]
+[section:basic_resolver_query ip::basic_resolver_query::basic_resolver_query]
+[indexterm2 basic_resolver_query..ip::basic_resolver_query]
+Construct with specified service name for any protocol.
-Resolve an endpoint to a list of entries.
-
- iterator_type resolve(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
+ ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload1 basic_resolver_query]``(
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = passive|address_configured);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload1 more...]]``
+Construct with specified service name for a given protocol.
-[endsect]
+ ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload2 basic_resolver_query]``(
+ const protocol_type & protocol,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = passive|address_configured);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload2 more...]]``
-[endsect]
+Construct with specified host name and service name for any protocol.
-[section:resolver_service ip::resolver_service::resolver_service]
-[indexterm2 resolver_service..ip::resolver_service]
-Construct a new resolver service for the specified [link boost_asio.reference.io_service `io_service`].
+ ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload3 basic_resolver_query]``(
+ const std::string & host,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = address_configured);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload3 more...]]``
- resolver_service(
- boost::asio::io_service & io_service);
+Construct with specified host name and service name for a given protocol.
+ ``[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload4 basic_resolver_query]``(
+ const protocol_type & protocol,
+ const std::string & host,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = address_configured);
+ `` [''''»''' [link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query.overload4 more...]]``
-[endsect]
+[section:overload1 ip::basic_resolver_query::basic_resolver_query (1 of 4 overloads)]
-[endsect]
+Construct with specified service name for any protocol.
-[section:ip__tcp ip::tcp]
+ basic_resolver_query(
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = passive|address_configured);
-Encapsulates the flags needed for TCP.
+This constructor is typically used to perform name resolution for local service binding.
- class tcp
+[heading Parameters]
+
-[heading Types]
-[table
- [[Name][Description]]
+[variablelist
+
+[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.]]
- [
+[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for local service binding.]]
- [[link boost_asio.reference.ip__tcp.acceptor [*acceptor]]]
- [The TCP acceptor type. ]
-
- ]
+]
- [
- [[link boost_asio.reference.ip__tcp.endpoint [*endpoint]]]
- [The type of a TCP endpoint. ]
-
- ]
+[heading Remarks]
+
+On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
- [
- [[link boost_asio.reference.ip__tcp.iostream [*iostream]]]
- [The TCP iostream type. ]
-
- ]
- [
- [[link boost_asio.reference.ip__tcp.no_delay [*no_delay]]]
- [Socket option for disabling the Nagle algorithm. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.ip__tcp.resolver [*resolver]]]
- [The TCP resolver type. ]
-
- ]
- [
+[section:overload2 ip::basic_resolver_query::basic_resolver_query (2 of 4 overloads)]
- [[link boost_asio.reference.ip__tcp.socket [*socket]]]
- [The TCP socket type. ]
-
- ]
-]
+Construct with specified service name for a given protocol.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__tcp.family [*family]]]
- [Obtain an identifier for the protocol family. ]
- ]
-
- [
- [[link boost_asio.reference.ip__tcp.protocol [*protocol]]]
- [Obtain an identifier for the protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__tcp.type [*type]]]
- [Obtain an identifier for the type of the protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__tcp.v4 [*v4]]]
- [Construct to represent the IPv4 TCP protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__tcp.v6 [*v6]]]
- [Construct to represent the IPv6 TCP protocol. ]
- ]
-
-]
+ basic_resolver_query(
+ const protocol_type & protocol,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = passive|address_configured);
-[heading Friends]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__tcp.operator_not__eq_ [*operator!=]]]
- [Compare two protocols for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__tcp.operator_eq__eq_ [*operator==]]]
- [Compare two protocols for equality. ]
- ]
-
-]
+This constructor is typically used to perform name resolution for local service binding with a specific protocol version.
-The [link boost_asio.reference.ip__tcp `ip::tcp`] class contains flags necessary for TCP sockets.
+[heading Parameters]
+
-[heading Thread Safety]
+[variablelist
-[*Distinct] [*objects:] Safe.
+[[protocol][A protocol object, normally representing either the IPv4 or IPv6 version of an internet protocol.]]
-[*Shared] [*objects:] Safe.
+[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number.]]
+[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for local service binding.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
-[*Header: ][^boost/asio/ip/tcp.hpp]
-[*Convenience header: ][^boost/asio.hpp]
-[section:acceptor ip::tcp::acceptor]
+[endsect]
-[indexterm2 acceptor..ip::tcp]
-The TCP acceptor type.
- typedef basic_socket_acceptor< tcp > acceptor;
+[section:overload3 ip::basic_resolver_query::basic_resolver_query (3 of 4 overloads)]
-[heading Types]
-[table
- [[Name][Description]]
+Construct with specified host name and service name for any protocol.
- [
- [[link boost_asio.reference.basic_socket_acceptor.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
+ basic_resolver_query(
+ const std::string & host,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = address_configured);
- [
- [[link boost_asio.reference.basic_socket_acceptor.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+This constructor is typically used to perform name resolution for communication with remote hosts.
- [
- [[link boost_asio.reference.basic_socket_acceptor.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
+[heading Parameters]
+
+
+[variablelist
- ]
+[[host][A string identifying a location. May be a descriptive name or a numeric address string. If an empty string and the passive flag has been specified, the resolved endpoints are suitable for local service binding. If an empty string and passive is not specified, the resolved endpoints will use the loopback address.]]
- [
+[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number. May be an empty string, in which case all resolved endpoints will have a port number of 0.]]
- [[link boost_asio.reference.basic_socket_acceptor.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
+[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for communication with remote hosts.]]
- [
+]
- [[link boost_asio.reference.basic_socket_acceptor.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
+[heading Remarks]
+
+On POSIX systems, host names may be locally defined in the file `/etc/hosts`. On Windows, host names may be defined in the file `c:\windows\system32\drivers\etc\hosts`. Remote host name resolution is performed using DNS. Operating systems may use additional locations when resolving host names (such as NETBIOS names on Windows).
- [[link boost_asio.reference.basic_socket_acceptor.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
+On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
- [
- [[link boost_asio.reference.basic_socket_acceptor.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_socket_acceptor.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
- [
+[section:overload4 ip::basic_resolver_query::basic_resolver_query (4 of 4 overloads)]
- [[link boost_asio.reference.basic_socket_acceptor.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
- [
+Construct with specified host name and service name for a given protocol.
- [[link boost_asio.reference.basic_socket_acceptor.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
- [
+ basic_resolver_query(
+ const protocol_type & protocol,
+ const std::string & host,
+ const std::string & service,
+ resolver_query_base::flags resolve_flags = address_configured);
- [[link boost_asio.reference.basic_socket_acceptor.native_handle_type [*native_handle_type]]]
- [The native representation of an acceptor. ]
-
- ]
- [
+This constructor is typically used to perform name resolution for communication with remote hosts.
- [[link boost_asio.reference.basic_socket_acceptor.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of an acceptor. ]
-
- ]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.basic_socket_acceptor.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+[variablelist
- ]
+[[protocol][A protocol object, normally representing either the IPv4 or IPv6 version of an internet protocol.]]
- [
+[[host][A string identifying a location. May be a descriptive name or a numeric address string. If an empty string and the passive flag has been specified, the resolved endpoints are suitable for local service binding. If an empty string and passive is not specified, the resolved endpoints will use the loopback address.]]
- [[link boost_asio.reference.basic_socket_acceptor.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+[[service][A string identifying the requested service. This may be a descriptive name or a numeric string corresponding to a port number. May be an empty string, in which case all resolved endpoints will have a port number of 0.]]
- [
+[[resolve_flags][A set of flags that determine how name resolution should be performed. The default flags are suitable for communication with remote hosts.]]
- [[link boost_asio.reference.basic_socket_acceptor.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
+]
- [
- [[link boost_asio.reference.basic_socket_acceptor.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
+[heading Remarks]
+
+On POSIX systems, host names may be locally defined in the file `/etc/hosts`. On Windows, host names may be defined in the file `c:\windows\system32\drivers\etc\hosts`. Remote host name resolution is performed using DNS. Operating systems may use additional locations when resolving host names (such as NETBIOS names on Windows).
- [
+On POSIX systems, service names are typically defined in the file `/etc/services`. On Windows, service names may be found in the file `c:\windows\system32\drivers\etc\services`. Operating systems may use additional locations when resolving service names.
- [[link boost_asio.reference.basic_socket_acceptor.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_socket_acceptor.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_socket_acceptor.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
- [
+[section:canonical_name ip::basic_resolver_query::canonical_name]
- [[link boost_asio.reference.basic_socket_acceptor.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
- [
+['Inherited from ip::resolver_query_base.]
- [[link boost_asio.reference.basic_socket_acceptor.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
-
- ]
+[indexterm2 canonical_name..ip::basic_resolver_query]
+Determine the canonical name of the host specified in the query.
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
+ static const flags canonical_name = implementation_defined;
- [
- [[link boost_asio.reference.basic_socket_acceptor.accept [*accept]]]
- [Accept a new connection.
- Accept a new connection and obtain the endpoint of the peer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.assign [*assign]]]
- [Assigns an existing native acceptor to the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.async_accept [*async_accept]]]
- [Start an asynchronous accept. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.basic_socket_acceptor [*basic_socket_acceptor]]]
- [Construct an acceptor without opening it.
- Construct an open acceptor.
+[endsect]
- Construct an acceptor opened on the given endpoint.
- Construct a basic_socket_acceptor on an existing native acceptor.
- Move-construct a basic_socket_acceptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.bind [*bind]]]
- [Bind the acceptor to the given local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.close [*close]]]
- [Close the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_option [*get_option]]]
- [Get an option from the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.io_control [*io_control]]]
- [Perform an IO control command on the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.is_open [*is_open]]]
- [Determine whether the acceptor is open. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.listen [*listen]]]
- [Place the acceptor into the state where it will listen for new connections. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native acceptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.native_handle [*native_handle]]]
- [Get the native acceptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native acceptor implementation.
+[section:flags ip::basic_resolver_query::flags]
- Sets the non-blocking mode of the native acceptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the acceptor.
- Sets the non-blocking mode of the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.open [*open]]]
- [Open the acceptor using the specified protocol. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_socket_acceptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.set_option [*set_option]]]
- [Set an option on the acceptor. ]
- ]
-
-]
+['Inherited from ip::resolver_query_base.]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[indexterm2 flags..ip::basic_resolver_query]
+A bitmask type (C++ Std [lib.bitmask.types]).
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
-[heading Data Members]
-[table
- [[Name][Description]]
+ typedef unspecified flags;
- [
- [[link boost_asio.reference.basic_socket_acceptor.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
+[heading Requirements]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
+[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
- ]
+[*Convenience header: ][^boost/asio.hpp]
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.basic_socket_acceptor.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-]
+[section:hints ip::basic_resolver_query::hints]
-The [link boost_asio.reference.basic_socket_acceptor `basic_socket_acceptor`] class template is used for accepting new socket connections.
+[indexterm2 hints..ip::basic_resolver_query]
+Get the hints associated with the query.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+ const boost::asio::detail::addrinfo_type & hints() const;
-[*Shared] [*objects:] Unsafe.
-[heading Example]
-
-Opening a socket acceptor with the SO\_REUSEADDR option enabled:
+[endsect]
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- 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();
+[section:host_name ip::basic_resolver_query::host_name]
+[indexterm2 host_name..ip::basic_resolver_query]
+Get the host name associated with the query.
+ std::string host_name() const;
-[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[endsect]
+
+
+
+[section:numeric_host ip::basic_resolver_query::numeric_host]
+
+
+['Inherited from ip::resolver_query_base.]
+
+[indexterm2 numeric_host..ip::basic_resolver_query]
+Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.
+
+
+ static const flags numeric_host = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[section:numeric_service ip::basic_resolver_query::numeric_service]
+
+
+['Inherited from ip::resolver_query_base.]
+
+[indexterm2 numeric_service..ip::basic_resolver_query]
+Service name should be treated as a numeric string defining a port number and no name resolution should be attempted.
+
+
+ static const flags numeric_service = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[section:passive ip::basic_resolver_query::passive]
+
+
+['Inherited from ip::resolver_query_base.]
+
+[indexterm2 passive..ip::basic_resolver_query]
+Indicate that returned endpoint is intended for use as a locally bound socket endpoint.
+
+
+ static const flags passive = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[section:protocol_type ip::basic_resolver_query::protocol_type]
+
+[indexterm2 protocol_type..ip::basic_resolver_query]
+The protocol type associated with the endpoint query.
+
+
+ typedef InternetProtocol protocol_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/basic_resolver_query.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -62745,13 +61659,198 @@
-[section:endpoint ip::tcp::endpoint]
+[section:service_name ip::basic_resolver_query::service_name]
-[indexterm2 endpoint..ip::tcp]
-The type of a TCP endpoint.
+[indexterm2 service_name..ip::basic_resolver_query]
+Get the service name associated with the query.
- typedef basic_endpoint< tcp > endpoint;
+ std::string service_name() const;
+
+
+
+[endsect]
+
+
+
+[section:v4_mapped ip::basic_resolver_query::v4_mapped]
+
+
+['Inherited from ip::resolver_query_base.]
+
+[indexterm2 v4_mapped..ip::basic_resolver_query]
+If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses.
+
+
+ static const flags v4_mapped = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:ip__host_name ip::host_name]
+
+[indexterm1 ip::host_name]
+Get the current host name.
+
+
+ std::string ``[link boost_asio.reference.ip__host_name.overload1 host_name]``();
+ `` [''''»''' [link boost_asio.reference.ip__host_name.overload1 more...]]``
+
+ std::string ``[link boost_asio.reference.ip__host_name.overload2 host_name]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__host_name.overload2 more...]]``
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/host_name.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:overload1 ip::host_name (1 of 2 overloads)]
+
+
+Get the current host name.
+
+
+ std::string host_name();
+
+
+
+[endsect]
+
+
+
+[section:overload2 ip::host_name (2 of 2 overloads)]
+
+
+Get the current host name.
+
+
+ std::string host_name(
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+[endsect]
+
+[section:ip__icmp ip::icmp]
+
+
+Encapsulates the flags needed for ICMP.
+
+
+ class icmp
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__icmp.endpoint [*endpoint]]]
+ [The type of a ICMP endpoint. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__icmp.resolver [*resolver]]]
+ [The ICMP resolver type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__icmp.socket [*socket]]]
+ [The ICMP socket type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__icmp.family [*family]]]
+ [Obtain an identifier for the protocol family. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__icmp.protocol [*protocol]]]
+ [Obtain an identifier for the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__icmp.type [*type]]]
+ [Obtain an identifier for the type of the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__icmp.v4 [*v4]]]
+ [Construct to represent the IPv4 ICMP protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__icmp.v6 [*v6]]]
+ [Construct to represent the IPv6 ICMP protocol. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__icmp.operator_not__eq_ [*operator!=]]]
+ [Compare two protocols for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__icmp.operator_eq__eq_ [*operator==]]]
+ [Compare two protocols for equality. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__icmp `ip::icmp`] class contains flags necessary for ICMP sockets.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Safe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/icmp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:endpoint ip::icmp::endpoint]
+
+[indexterm2 endpoint..ip::icmp]
+The type of a ICMP endpoint.
+
+
+ typedef basic_endpoint< icmp > endpoint;
[heading Types]
@@ -62897,7 +61996,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[*Header: ][^boost/asio/ip/icmp.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -62906,9 +62005,9 @@
-[section:family ip::tcp::family]
+[section:family ip::icmp::family]
-[indexterm2 family..ip::tcp]
+[indexterm2 family..ip::icmp]
Obtain an identifier for the protocol family.
@@ -62920,166 +62019,20 @@
-[section:iostream ip::tcp::iostream]
-
-[indexterm2 iostream..ip::tcp]
-The TCP iostream type.
-
-
- typedef basic_socket_iostream< tcp > iostream;
-
-
-[heading Types]
-[table
- [[Name][Description]]
-
- [
-
- [[link boost_asio.reference.basic_socket_iostream.duration_type [*duration_type]]]
- [The duration type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.basic_socket_iostream.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.basic_socket_iostream.time_type [*time_type]]]
- [The time type. ]
-
- ]
-
-]
-
-[heading Member Functions]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.basic_socket_iostream [*basic_socket_iostream]]]
- [Construct a basic_socket_iostream without establishing a connection.
-
- Establish a connection to an endpoint corresponding to a resolver query. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.close [*close]]]
- [Close the connection. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.connect [*connect]]]
- [Establish a connection to an endpoint corresponding to a resolver query. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.error [*error]]]
- [Get the last error associated with the stream. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.expires_at [*expires_at]]]
- [Get the stream's expiry time as an absolute time.
-
- Set the stream's expiry time as an absolute time. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.expires_from_now [*expires_from_now]]]
- [Get the timer's expiry time relative to now.
-
- Set the stream's expiry time relative to now. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.rdbuf [*rdbuf]]]
- [Return a pointer to the underlying streambuf. ]
- ]
-
-]
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/tcp.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[section:no_delay ip::tcp::no_delay]
-
-[indexterm2 no_delay..ip::tcp]
-Socket option for disabling the Nagle algorithm.
-
-
- typedef implementation_defined no_delay;
-
-
-
-Implements the IPPROTO\_TCP/TCP\_NODELAY socket option.
-
-
-[heading Examples]
-
-Setting the option:
-
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::ip::tcp::no_delay option(true);
- socket.set_option(option);
-
-
-
-
-
-Getting the current option value:
-
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::ip::tcp::no_delay option;
- socket.get_option(option);
- bool is_set = option.value();
-
-
-
-
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ip/tcp.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[section:operator_not__eq_ ip::tcp::operator!=]
+[section:operator_not__eq_ ip::icmp::operator!=]
-[indexterm2 operator!=..ip::tcp]
+[indexterm2 operator!=..ip::icmp]
Compare two protocols for inequality.
friend bool operator!=(
- const tcp & p1,
- const tcp & p2);
+ const icmp & p1,
+ const icmp & p2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[*Header: ][^boost/asio/ip/icmp.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -63088,20 +62041,20 @@
-[section:operator_eq__eq_ ip::tcp::operator==]
+[section:operator_eq__eq_ ip::icmp::operator==]
-[indexterm2 operator==..ip::tcp]
+[indexterm2 operator==..ip::icmp]
Compare two protocols for equality.
friend bool operator==(
- const tcp & p1,
- const tcp & p2);
+ const icmp & p1,
+ const icmp & p2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[*Header: ][^boost/asio/ip/icmp.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -63110,9 +62063,9 @@
-[section:protocol ip::tcp::protocol]
+[section:protocol ip::icmp::protocol]
-[indexterm2 protocol..ip::tcp]
+[indexterm2 protocol..ip::icmp]
Obtain an identifier for the protocol.
@@ -63124,13 +62077,13 @@
-[section:resolver ip::tcp::resolver]
+[section:resolver ip::icmp::resolver]
-[indexterm2 resolver..ip::tcp]
-The TCP resolver type.
+[indexterm2 resolver..ip::icmp]
+The ICMP resolver type.
- typedef basic_resolver< tcp > resolver;
+ typedef basic_resolver< icmp > resolver;
[heading Types]
@@ -63262,7 +62215,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[*Header: ][^boost/asio/ip/icmp.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -63271,13 +62224,13 @@
-[section:socket ip::tcp::socket]
+[section:socket ip::icmp::socket]
-[indexterm2 socket..ip::tcp]
-The TCP socket type.
+[indexterm2 socket..ip::icmp]
+The ICMP socket type.
- typedef basic_stream_socket< tcp > socket;
+ typedef basic_raw_socket< icmp > socket;
[heading Types]
@@ -63286,154 +62239,154 @@
[
- [[link boost_asio.reference.basic_stream_socket.broadcast [*broadcast]]]
+ [[link boost_asio.reference.basic_raw_socket.broadcast [*broadcast]]]
[Socket option to permit sending of broadcast messages. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.bytes_readable [*bytes_readable]]]
+ [[link boost_asio.reference.basic_raw_socket.bytes_readable [*bytes_readable]]]
[IO control command to get the amount of data that can be read without blocking. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.debug [*debug]]]
+ [[link boost_asio.reference.basic_raw_socket.debug [*debug]]]
[Socket option to enable socket-level debugging. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.do_not_route [*do_not_route]]]
+ [[link boost_asio.reference.basic_raw_socket.do_not_route [*do_not_route]]]
[Socket option to prevent routing, use local interfaces only. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.enable_connection_aborted [*enable_connection_aborted]]]
+ [[link boost_asio.reference.basic_raw_socket.enable_connection_aborted [*enable_connection_aborted]]]
[Socket option to report aborted connections on accept. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.endpoint_type [*endpoint_type]]]
+ [[link boost_asio.reference.basic_raw_socket.endpoint_type [*endpoint_type]]]
[The endpoint type. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.implementation_type [*implementation_type]]]
+ [[link boost_asio.reference.basic_raw_socket.implementation_type [*implementation_type]]]
[The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.keep_alive [*keep_alive]]]
+ [[link boost_asio.reference.basic_raw_socket.keep_alive [*keep_alive]]]
[Socket option to send keep-alives. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.linger [*linger]]]
+ [[link boost_asio.reference.basic_raw_socket.linger [*linger]]]
[Socket option to specify whether the socket lingers on close if unsent data is present. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.lowest_layer_type [*lowest_layer_type]]]
+ [[link boost_asio.reference.basic_raw_socket.lowest_layer_type [*lowest_layer_type]]]
[A basic_socket is always the lowest layer. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.message_flags [*message_flags]]]
+ [[link boost_asio.reference.basic_raw_socket.message_flags [*message_flags]]]
[Bitmask type for flags that can be passed to send and receive operations. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.native_handle_type [*native_handle_type]]]
+ [[link boost_asio.reference.basic_raw_socket.native_handle_type [*native_handle_type]]]
[The native representation of a socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.native_type [*native_type]]]
+ [[link boost_asio.reference.basic_raw_socket.native_type [*native_type]]]
[(Deprecated: Use native_handle_type.) The native representation of a socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.non_blocking_io [*non_blocking_io]]]
+ [[link boost_asio.reference.basic_raw_socket.non_blocking_io [*non_blocking_io]]]
[(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.protocol_type [*protocol_type]]]
+ [[link boost_asio.reference.basic_raw_socket.protocol_type [*protocol_type]]]
[The protocol type. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.receive_buffer_size [*receive_buffer_size]]]
+ [[link boost_asio.reference.basic_raw_socket.receive_buffer_size [*receive_buffer_size]]]
[Socket option for the receive buffer size of a socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.receive_low_watermark [*receive_low_watermark]]]
+ [[link boost_asio.reference.basic_raw_socket.receive_low_watermark [*receive_low_watermark]]]
[Socket option for the receive low watermark. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.reuse_address [*reuse_address]]]
+ [[link boost_asio.reference.basic_raw_socket.reuse_address [*reuse_address]]]
[Socket option to allow the socket to be bound to an address that is already in use. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.send_buffer_size [*send_buffer_size]]]
+ [[link boost_asio.reference.basic_raw_socket.send_buffer_size [*send_buffer_size]]]
[Socket option for the send buffer size of a socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.send_low_watermark [*send_low_watermark]]]
+ [[link boost_asio.reference.basic_raw_socket.send_low_watermark [*send_low_watermark]]]
[Socket option for the send low watermark. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.service_type [*service_type]]]
+ [[link boost_asio.reference.basic_raw_socket.service_type [*service_type]]]
[The type of the service that will be used to provide I/O operations. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.shutdown_type [*shutdown_type]]]
+ [[link boost_asio.reference.basic_raw_socket.shutdown_type [*shutdown_type]]]
[Different ways a socket may be shutdown. ]
]
@@ -63445,179 +62398,177 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_stream_socket.assign [*assign]]]
+ [[link boost_asio.reference.basic_raw_socket.assign [*assign]]]
[Assign an existing native socket to the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.async_connect [*async_connect]]]
+ [[link boost_asio.reference.basic_raw_socket.async_connect [*async_connect]]]
[Start an asynchronous connect. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
+ [[link boost_asio.reference.basic_raw_socket.async_receive [*async_receive]]]
+ [Start an asynchronous receive on a connected socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.async_receive [*async_receive]]]
+ [[link boost_asio.reference.basic_raw_socket.async_receive_from [*async_receive_from]]]
[Start an asynchronous receive. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.async_send [*async_send]]]
- [Start an asynchronous send. ]
+ [[link boost_asio.reference.basic_raw_socket.async_send [*async_send]]]
+ [Start an asynchronous send on a connected socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
+ [[link boost_asio.reference.basic_raw_socket.async_send_to [*async_send_to]]]
+ [Start an asynchronous send. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.at_mark [*at_mark]]]
+ [[link boost_asio.reference.basic_raw_socket.at_mark [*at_mark]]]
[Determine whether the socket is at the out-of-band data mark. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.available [*available]]]
+ [[link boost_asio.reference.basic_raw_socket.available [*available]]]
[Determine the number of bytes available for reading. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.basic_stream_socket [*basic_stream_socket]]]
- [Construct a basic_stream_socket without opening it.
+ [[link boost_asio.reference.basic_raw_socket.basic_raw_socket [*basic_raw_socket]]]
+ [Construct a basic_raw_socket without opening it.
- Construct and open a basic_stream_socket.
+ Construct and open a basic_raw_socket.
- Construct a basic_stream_socket, opening it and binding it to the given local endpoint.
+ Construct a basic_raw_socket, opening it and binding it to the given local endpoint.
- Construct a basic_stream_socket on an existing native socket.
+ Construct a basic_raw_socket on an existing native socket.
- Move-construct a basic_stream_socket from another. ]
+ Move-construct a basic_raw_socket from another. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.bind [*bind]]]
+ [[link boost_asio.reference.basic_raw_socket.bind [*bind]]]
[Bind the socket to the given local endpoint. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.cancel [*cancel]]]
+ [[link boost_asio.reference.basic_raw_socket.cancel [*cancel]]]
[Cancel all asynchronous operations associated with the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.close [*close]]]
+ [[link boost_asio.reference.basic_raw_socket.close [*close]]]
[Close the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.connect [*connect]]]
+ [[link boost_asio.reference.basic_raw_socket.connect [*connect]]]
[Connect the socket to the specified endpoint. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.get_io_service [*get_io_service]]]
+ [[link boost_asio.reference.basic_raw_socket.get_io_service [*get_io_service]]]
[Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.get_option [*get_option]]]
+ [[link boost_asio.reference.basic_raw_socket.get_option [*get_option]]]
[Get an option from the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.io_control [*io_control]]]
+ [[link boost_asio.reference.basic_raw_socket.io_control [*io_control]]]
[Perform an IO control command on the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.is_open [*is_open]]]
+ [[link boost_asio.reference.basic_raw_socket.is_open [*is_open]]]
[Determine whether the socket is open. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.local_endpoint [*local_endpoint]]]
+ [[link boost_asio.reference.basic_raw_socket.local_endpoint [*local_endpoint]]]
[Get the local endpoint of the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.lowest_layer [*lowest_layer]]]
+ [[link boost_asio.reference.basic_raw_socket.lowest_layer [*lowest_layer]]]
[Get a reference to the lowest layer.
Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.native [*native]]]
+ [[link boost_asio.reference.basic_raw_socket.native [*native]]]
[(Deprecated: Use native_handle().) Get the native socket representation. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.native_handle [*native_handle]]]
+ [[link boost_asio.reference.basic_raw_socket.native_handle [*native_handle]]]
[Get the native socket representation. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.native_non_blocking [*native_non_blocking]]]
+ [[link boost_asio.reference.basic_raw_socket.native_non_blocking [*native_non_blocking]]]
[Gets the non-blocking mode of the native socket implementation.
Sets the non-blocking mode of the native socket implementation. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.non_blocking [*non_blocking]]]
+ [[link boost_asio.reference.basic_raw_socket.non_blocking [*non_blocking]]]
[Gets the non-blocking mode of the socket.
Sets the non-blocking mode of the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.open [*open]]]
+ [[link boost_asio.reference.basic_raw_socket.open [*open]]]
[Open the socket using the specified protocol. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.operator_eq_ [*operator=]]]
- [Move-assign a basic_stream_socket from another. ]
+ [[link boost_asio.reference.basic_raw_socket.operator_eq_ [*operator=]]]
+ [Move-assign a basic_raw_socket from another. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.read_some [*read_some]]]
- [Read some data from the socket. ]
+ [[link boost_asio.reference.basic_raw_socket.receive [*receive]]]
+ [Receive some data on a connected socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.receive [*receive]]]
- [Receive some data on the socket.
-
- Receive some data on a connected socket. ]
+ [[link boost_asio.reference.basic_raw_socket.receive_from [*receive_from]]]
+ [Receive raw data with the endpoint of the sender. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.remote_endpoint [*remote_endpoint]]]
+ [[link boost_asio.reference.basic_raw_socket.remote_endpoint [*remote_endpoint]]]
[Get the remote endpoint of the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.send [*send]]]
- [Send some data on the socket. ]
+ [[link boost_asio.reference.basic_raw_socket.send [*send]]]
+ [Send some data on a connected socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.set_option [*set_option]]]
- [Set an option on the socket. ]
+ [[link boost_asio.reference.basic_raw_socket.send_to [*send_to]]]
+ [Send raw data to the specified endpoint. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
+ [[link boost_asio.reference.basic_raw_socket.set_option [*set_option]]]
+ [Set an option on the socket. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.write_some [*write_some]]]
- [Write some data to the socket. ]
+ [[link boost_asio.reference.basic_raw_socket.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
]
]
@@ -63627,12 +62578,12 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_stream_socket.get_implementation [*get_implementation]]]
+ [[link boost_asio.reference.basic_raw_socket.get_implementation [*get_implementation]]]
[Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.get_service [*get_service]]]
+ [[link boost_asio.reference.basic_raw_socket.get_service [*get_service]]]
[Get the service associated with the I/O object. ]
]
@@ -63643,27 +62594,27 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_stream_socket.max_connections [*max_connections]]]
+ [[link boost_asio.reference.basic_raw_socket.max_connections [*max_connections]]]
[The maximum length of the queue of pending incoming connections. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.message_do_not_route [*message_do_not_route]]]
+ [[link boost_asio.reference.basic_raw_socket.message_do_not_route [*message_do_not_route]]]
[Specify that the data should not be subject to routing. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.message_end_of_record [*message_end_of_record]]]
+ [[link boost_asio.reference.basic_raw_socket.message_end_of_record [*message_end_of_record]]]
[Specifies that the data marks the end of a record. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.message_out_of_band [*message_out_of_band]]]
+ [[link boost_asio.reference.basic_raw_socket.message_out_of_band [*message_out_of_band]]]
[Process out-of-band data. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.message_peek [*message_peek]]]
+ [[link boost_asio.reference.basic_raw_socket.message_peek [*message_peek]]]
[Peek at incoming data without removing it from the input queue. ]
]
@@ -63674,33 +62625,32 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_stream_socket.implementation [*implementation]]]
+ [[link boost_asio.reference.basic_raw_socket.implementation [*implementation]]]
[(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.basic_stream_socket.service [*service]]]
+ [[link boost_asio.reference.basic_raw_socket.service [*service]]]
[(Deprecated: Use get_service().) The service associated with the I/O object. ]
]
]
-The [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] class template provides asynchronous and blocking stream-oriented socket functionality.
+The [link boost_asio.reference.basic_raw_socket `basic_raw_socket`] class template provides asynchronous and blocking raw-oriented socket functionality.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
-
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/tcp.hpp]
+[*Header: ][^boost/asio/ip/icmp.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -63709,9 +62659,9 @@
-[section:type ip::tcp::type]
+[section:type ip::icmp::type]
-[indexterm2 type..ip::tcp]
+[indexterm2 type..ip::icmp]
Obtain an identifier for the type of the protocol.
@@ -63723,13 +62673,13 @@
-[section:v4 ip::tcp::v4]
+[section:v4 ip::icmp::v4]
-[indexterm2 v4..ip::tcp]
-Construct to represent the IPv4 TCP protocol.
+[indexterm2 v4..ip::icmp]
+Construct to represent the IPv4 ICMP protocol.
- static tcp v4();
+ static icmp v4();
@@ -63737,13 +62687,13 @@
-[section:v6 ip::tcp::v6]
+[section:v6 ip::icmp::v6]
-[indexterm2 v6..ip::tcp]
-Construct to represent the IPv6 TCP protocol.
+[indexterm2 v6..ip::icmp]
+Construct to represent the IPv6 ICMP protocol.
- static tcp v6();
+ static icmp v6();
@@ -63753,253 +62703,134 @@
[endsect]
-[section:ip__udp ip::udp]
-
-Encapsulates the flags needed for UDP.
+[section:ip__multicast__enable_loopback ip::multicast::enable_loopback]
+[indexterm1 ip::multicast::enable_loopback]
+Socket option determining whether outgoing multicast packets will be received on the same socket if it is a member of the multicast group.
- class udp
+ typedef implementation_defined enable_loopback;
-[heading Types]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__udp.endpoint [*endpoint]]]
- [The type of a UDP endpoint. ]
-
- ]
+Implements the IPPROTO\_IP/IP\_MULTICAST\_LOOP socket option.
- [
- [[link boost_asio.reference.ip__udp.resolver [*resolver]]]
- [The UDP resolver type. ]
+[heading Examples]
- ]
-
- [
+Setting the option:
- [[link boost_asio.reference.ip__udp.socket [*socket]]]
- [The UDP socket type. ]
-
- ]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::multicast::enable_loopback option(true);
+ socket.set_option(option);
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__udp.family [*family]]]
- [Obtain an identifier for the protocol family. ]
- ]
-
- [
- [[link boost_asio.reference.ip__udp.protocol [*protocol]]]
- [Obtain an identifier for the protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__udp.type [*type]]]
- [Obtain an identifier for the type of the protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__udp.v4 [*v4]]]
- [Construct to represent the IPv4 UDP protocol. ]
- ]
-
- [
- [[link boost_asio.reference.ip__udp.v6 [*v6]]]
- [Construct to represent the IPv6 UDP protocol. ]
- ]
-
-]
-[heading Friends]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__udp.operator_not__eq_ [*operator!=]]]
- [Compare two protocols for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__udp.operator_eq__eq_ [*operator==]]]
- [Compare two protocols for equality. ]
- ]
-
-]
+Getting the current option value:
-The [link boost_asio.reference.ip__udp `ip::udp`] class contains flags necessary for UDP sockets.
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::multicast::enable_loopback option;
+ socket.get_option(option);
+ bool is_set = option.value();
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Safe.
[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+[*Header: ][^boost/asio/ip/multicast.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:endpoint ip::udp::endpoint]
+[endsect]
-[indexterm2 endpoint..ip::udp]
-The type of a UDP endpoint.
- typedef basic_endpoint< udp > endpoint;
+[section:ip__multicast__hops ip::multicast::hops]
+[indexterm1 ip::multicast::hops]
+Socket option for time-to-live associated with outgoing multicast packets.
-[heading Types]
-[table
- [[Name][Description]]
- [
+ typedef implementation_defined hops;
- [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
-
- ]
- [
- [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
+Implements the IPPROTO\_IP/IP\_MULTICAST\_TTL socket option.
+
+
+[heading Examples]
- ]
+Setting the option:
-]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::multicast::hops option(4);
+ socket.set_option(option);
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
- [Get the IP address associated with the endpoint.
- Set the IP address associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
- [Default constructor.
- Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
- Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+Getting the current option value:
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
- [Get the port associated with the endpoint. The port number is always in the host's byte order.
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::multicast::hops option;
+ socket.get_option(option);
+ int ttl = option.value();
- Set the port associated with the endpoint. The port number is always in the host's byte order. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
- ]
-
-]
-[heading Friends]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
- ]
-
-]
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
- ]
-
-]
-The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
+[heading Requirements]
-[heading Thread Safety]
+[*Header: ][^boost/asio/ip/multicast.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:ip__multicast__join_group ip::multicast::join_group]
+
+[indexterm1 ip::multicast::join_group]
+Socket option to join a multicast group on a specified interface.
+
+
+ typedef implementation_defined join_group;
+
+
+
+Implements the IPPROTO\_IP/IP\_ADD\_MEMBERSHIP socket option.
+
+
+[heading Examples]
-[*Distinct] [*objects:] Safe.
+Setting the option to join a multicast group:
+
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::address multicast_address =
+ boost::asio::ip::address::from_string("225.0.0.1");
+ boost::asio::ip::multicast::join_group option(multicast_address);
+ socket.set_option(option);
+
-[*Shared] [*objects:] Unsafe.
@@ -64007,7 +62838,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+[*Header: ][^boost/asio/ip/multicast.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -64016,34 +62847,39 @@
-[section:family ip::udp::family]
+[section:ip__multicast__leave_group ip::multicast::leave_group]
-[indexterm2 family..ip::udp]
-Obtain an identifier for the protocol family.
+[indexterm1 ip::multicast::leave_group]
+Socket option to leave a multicast group on a specified interface.
- int family() const;
+ typedef implementation_defined leave_group;
-[endsect]
+Implements the IPPROTO\_IP/IP\_DROP\_MEMBERSHIP socket option.
+[heading Examples]
+
+Setting the option to leave a multicast group:
+
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::address multicast_address =
+ boost::asio::ip::address::from_string("225.0.0.1");
+ boost::asio::ip::multicast::leave_group option(multicast_address);
+ socket.set_option(option);
+
-[section:operator_not__eq_ ip::udp::operator!=]
-[indexterm2 operator!=..ip::udp]
-Compare two protocols for inequality.
- friend bool operator!=(
- const udp & p1,
- const udp & p2);
[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+[*Header: ][^boost/asio/ip/multicast.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -64052,49 +62888,53 @@
-[section:operator_eq__eq_ ip::udp::operator==]
+[section:ip__multicast__outbound_interface ip::multicast::outbound_interface]
-[indexterm2 operator==..ip::udp]
-Compare two protocols for equality.
+[indexterm1 ip::multicast::outbound_interface]
+Socket option for local interface to use for outgoing multicast packets.
- friend bool operator==(
- const udp & p1,
- const udp & p2);
+ typedef implementation_defined outbound_interface;
-[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+Implements the IPPROTO\_IP/IP\_MULTICAST\_IF socket option.
-[*Convenience header: ][^boost/asio.hpp]
+[heading Examples]
+
+Setting the option:
-[endsect]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::address_v4 local_interface =
+ boost::asio::ip::address_v4::from_string("1.2.3.4");
+ boost::asio::ip::multicast::outbound_interface option(local_interface);
+ socket.set_option(option);
-[section:protocol ip::udp::protocol]
-[indexterm2 protocol..ip::udp]
-Obtain an identifier for the protocol.
- int protocol() const;
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/multicast.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:ip__resolver_query_base ip::resolver_query_base]
-[section:resolver ip::udp::resolver]
-[indexterm2 resolver..ip::udp]
-The UDP resolver type.
+The [link boost_asio.reference.ip__resolver_query_base `ip::resolver_query_base`] class is used as a base for the [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class templates to provide a common place to define the flag constants.
- typedef basic_resolver< udp > resolver;
+ class resolver_query_base
[heading Types]
@@ -64103,130 +62943,127 @@
[
- [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
+ [[link boost_asio.reference.ip__resolver_query_base.flags [*flags]]]
+ [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
]
- [
+]
- [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
[
-
- [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
- [The iterator type. ]
-
+ [[link boost_asio.reference.ip__resolver_query_base._resolver_query_base [*~resolver_query_base]]]
+ [Protected destructor to prevent deletion through this type. ]
]
+
+]
- [
+[heading Data Members]
+[table
+ [[Name][Description]]
- [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
+ [
+ [[link boost_asio.reference.ip__resolver_query_base.address_configured [*address_configured]]]
+ [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
]
[
-
- [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
- [The query type. ]
-
+ [[link boost_asio.reference.ip__resolver_query_base.all_matching [*all_matching]]]
+ [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
]
[
+ [[link boost_asio.reference.ip__resolver_query_base.canonical_name [*canonical_name]]]
+ [Determine the canonical name of the host specified in the query. ]
+ ]
- [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
+ [
+ [[link boost_asio.reference.ip__resolver_query_base.numeric_host [*numeric_host]]]
+ [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
]
-]
+ [
+ [[link boost_asio.reference.ip__resolver_query_base.numeric_service [*numeric_service]]]
+ [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
+ ]
-[heading Member Functions]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously perform forward resolution of a query to a list of entries.
-
- Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
- [Constructor. ]
- ]
-
[
- [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
- [Cancel any asynchronous operations that are waiting on the resolver. ]
+ [[link boost_asio.reference.ip__resolver_query_base.passive [*passive]]]
+ [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
]
-
+
[
- [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.ip__resolver_query_base.v4_mapped [*v4_mapped]]]
+ [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Perform forward resolution of a query to a list of entries.
- Perform reverse resolution of an endpoint to a list of entries. ]
- ]
-
]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[heading Requirements]
- [
- [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
+[*Header: ][^boost/asio/ip/resolver_query_base.hpp]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+[*Convenience header: ][^boost/asio.hpp]
- [
- [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
- [
- [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
+[section:address_configured ip::resolver_query_base::address_configured]
-]
+[indexterm2 address_configured..ip::resolver_query_base]
+Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system.
-The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
+ static const flags address_configured = implementation_defined;
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+
+[endsect]
+
+
+
+[section:all_matching ip::resolver_query_base::all_matching]
+
+[indexterm2 all_matching..ip::resolver_query_base]
+If used with v4\_mapped, return all matching IPv6 and IPv4 addresses.
+
+
+ static const flags all_matching = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[section:canonical_name ip::resolver_query_base::canonical_name]
+
+[indexterm2 canonical_name..ip::resolver_query_base]
+Determine the canonical name of the host specified in the query.
+
+
+ static const flags canonical_name = implementation_defined;
+
+
+
+[endsect]
+
+
+
+[section:flags ip::resolver_query_base::flags]
+
+[indexterm2 flags..ip::resolver_query_base]
+A bitmask type (C++ Std [lib.bitmask.types]).
+ typedef unspecified flags;
+
[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+[*Header: ][^boost/asio/ip/resolver_query_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -64235,367 +63072,172 @@
-[section:socket ip::udp::socket]
+[section:numeric_host ip::resolver_query_base::numeric_host]
-[indexterm2 socket..ip::udp]
-The UDP socket type.
+[indexterm2 numeric_host..ip::resolver_query_base]
+Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted.
- typedef basic_datagram_socket< udp > socket;
+ static const flags numeric_host = implementation_defined;
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+[section:numeric_service ip::resolver_query_base::numeric_service]
- [
+[indexterm2 numeric_service..ip::resolver_query_base]
+Service name should be treated as a numeric string defining a port number and no name resolution should be attempted.
- [[link boost_asio.reference.basic_datagram_socket.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
- [
+ static const flags numeric_service = implementation_defined;
- [[link boost_asio.reference.basic_datagram_socket.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_datagram_socket.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+[section:passive ip::resolver_query_base::passive]
- [[link boost_asio.reference.basic_datagram_socket.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[indexterm2 passive..ip::resolver_query_base]
+Indicate that returned endpoint is intended for use as a locally bound socket endpoint.
- [
- [[link boost_asio.reference.basic_datagram_socket.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
+ static const flags passive = implementation_defined;
- [
- [[link boost_asio.reference.basic_datagram_socket.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.lowest_layer_type [*lowest_layer_type]]]
- [A basic_socket is always the lowest layer. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
+[section:v4_mapped ip::resolver_query_base::v4_mapped]
- [
+[indexterm2 v4_mapped..ip::resolver_query_base]
+If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses.
- [[link boost_asio.reference.basic_datagram_socket.native_handle_type [*native_handle_type]]]
- [The native representation of a socket. ]
-
- ]
- [
+ static const flags v4_mapped = implementation_defined;
- [[link boost_asio.reference.basic_datagram_socket.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_datagram_socket.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
- [
+[section:_resolver_query_base ip::resolver_query_base::~resolver_query_base]
- [[link boost_asio.reference.basic_datagram_socket.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
+[indexterm2 ~resolver_query_base..ip::resolver_query_base]
+Protected destructor to prevent deletion through this type.
- [
- [[link boost_asio.reference.basic_datagram_socket.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
+ ~resolver_query_base();
- [
- [[link boost_asio.reference.basic_datagram_socket.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
+[endsect]
- [
+[section:ip__resolver_service ip::resolver_service]
- [[link boost_asio.reference.basic_datagram_socket.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
- [
+Default service implementation for a resolver.
- [[link boost_asio.reference.basic_datagram_socket.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
-
- ]
-]
+ template<
+ typename ``[link boost_asio.reference.InternetProtocol InternetProtocol]``>
+ class resolver_service :
+ public io_service::service
-[heading Member Functions]
+
+[heading Types]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.basic_datagram_socket.assign [*assign]]]
- [Assign an existing native socket to the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_receive [*async_receive]]]
- [Start an asynchronous receive on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_receive_from [*async_receive_from]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_send [*async_send]]]
- [Start an asynchronous send on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_send_to [*async_send_to]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.basic_datagram_socket [*basic_datagram_socket]]]
- [Construct a basic_datagram_socket without opening it.
-
- Construct and open a basic_datagram_socket.
-
- Construct a basic_datagram_socket, opening it and binding it to the given local endpoint.
-
- Construct a basic_datagram_socket on an existing native socket.
- Move-construct a basic_datagram_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.bind [*bind]]]
- [Bind the socket to the given local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.close [*close]]]
- [Close the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.connect [*connect]]]
- [Connect the socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.get_option [*get_option]]]
- [Get an option from the socket. ]
- ]
+ [[link boost_asio.reference.ip__resolver_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
- [
- [[link boost_asio.reference.basic_datagram_socket.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
]
-
+
[
- [[link boost_asio.reference.basic_datagram_socket.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
+
+ [[link boost_asio.reference.ip__resolver_service.implementation_type [*implementation_type]]]
+ [The type of a resolver implementation. ]
- [
- [[link boost_asio.reference.basic_datagram_socket.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the socket. ]
]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
- Get a const reference to the lowest layer. ]
- ]
-
[
- [[link boost_asio.reference.basic_datagram_socket.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket representation. ]
- ]
+
+ [[link boost_asio.reference.ip__resolver_service.iterator_type [*iterator_type]]]
+ [The iterator type. ]
- [
- [[link boost_asio.reference.basic_datagram_socket.native_handle [*native_handle]]]
- [Get the native socket representation. ]
]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
[
- [[link boost_asio.reference.basic_datagram_socket.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
- Sets the non-blocking mode of the socket. ]
- ]
+ [[link boost_asio.reference.ip__resolver_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
- [
- [[link boost_asio.reference.basic_datagram_socket.open [*open]]]
- [Open the socket using the specified protocol. ]
]
-
+
[
- [[link boost_asio.reference.basic_datagram_socket.operator_eq_ [*operator=]]]
- [Move-assign a basic_datagram_socket from another. ]
- ]
+
+ [[link boost_asio.reference.ip__resolver_service.query_type [*query_type]]]
+ [The query type. ]
- [
- [[link boost_asio.reference.basic_datagram_socket.receive [*receive]]]
- [Receive some data on a connected socket. ]
]
-
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.basic_datagram_socket.receive_from [*receive_from]]]
- [Receive a datagram with the endpoint of the sender. ]
+ [[link boost_asio.reference.ip__resolver_service.async_resolve [*async_resolve]]]
+ [Asynchronously resolve a query to a list of entries.
+
+ Asynchronously resolve an endpoint to a list of entries. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint of the socket. ]
+ [[link boost_asio.reference.ip__resolver_service.cancel [*cancel]]]
+ [Cancel pending asynchronous operations. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.send [*send]]]
- [Send some data on a connected socket. ]
+ [[link boost_asio.reference.ip__resolver_service.construct [*construct]]]
+ [Construct a new resolver implementation. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.send_to [*send_to]]]
- [Send a datagram to the specified endpoint. ]
+ [[link boost_asio.reference.ip__resolver_service.destroy [*destroy]]]
+ [Destroy a resolver implementation. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.set_option [*set_option]]]
- [Set an option on the socket. ]
+ [[link boost_asio.reference.ip__resolver_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
-]
-
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+ [[link boost_asio.reference.ip__resolver_service.resolve [*resolve]]]
+ [Resolve a query to a list of entries.
- [
- [[link boost_asio.reference.basic_datagram_socket.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
+ Resolve an endpoint to a list of entries. ]
]
[
- [[link boost_asio.reference.basic_datagram_socket.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
+ [[link boost_asio.reference.ip__resolver_service.resolver_service [*resolver_service]]]
+ [Construct a new resolver service for the specified io_service. ]
]
]
@@ -64605,106 +63247,93 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_datagram_socket.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
+ [[link boost_asio.reference.ip__resolver_service.id [*id]]]
+ [The unique service identifier. ]
]
]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
+[heading Requirements]
-]
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
-The [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class template provides asynchronous and blocking datagram-oriented socket functionality.
+[*Convenience header: ][^boost/asio.hpp]
+[section:async_resolve ip::resolver_service::async_resolve]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[indexterm2 async_resolve..ip::resolver_service]
+Asynchronously resolve a query to a list of entries.
-[*Shared] [*objects:] Unsafe.
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void ``[link boost_asio.reference.ip__resolver_service.async_resolve.overload1 async_resolve]``(
+ implementation_type & impl,
+ const query_type & query,
+ ResolveHandler handler);
+ `` [''''»''' [link boost_asio.reference.ip__resolver_service.async_resolve.overload1 more...]]``
+Asynchronously resolve an endpoint to a list of entries.
-[heading Requirements]
-[*Header: ][^boost/asio/ip/udp.hpp]
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void ``[link boost_asio.reference.ip__resolver_service.async_resolve.overload2 async_resolve]``(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ ResolveHandler handler);
+ `` [''''»''' [link boost_asio.reference.ip__resolver_service.async_resolve.overload2 more...]]``
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload1 ip::resolver_service::async_resolve (1 of 2 overloads)]
-[endsect]
+Asynchronously resolve a query to a list of entries.
-[section:type ip::udp::type]
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void async_resolve(
+ implementation_type & impl,
+ const query_type & query,
+ ResolveHandler handler);
-[indexterm2 type..ip::udp]
-Obtain an identifier for the type of the protocol.
- int type() const;
+[endsect]
-[endsect]
+[section:overload2 ip::resolver_service::async_resolve (2 of 2 overloads)]
+Asynchronously resolve an endpoint to a list of entries.
-[section:v4 ip::udp::v4]
-[indexterm2 v4..ip::udp]
-Construct to represent the IPv4 UDP protocol.
+ template<
+ typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
+ void async_resolve(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ ResolveHandler handler);
- static udp v4();
+[endsect]
[endsect]
+[section:cancel ip::resolver_service::cancel]
-[section:v6 ip::udp::v6]
-
-[indexterm2 v6..ip::udp]
-Construct to represent the IPv6 UDP protocol.
+[indexterm2 cancel..ip::resolver_service]
+Cancel pending asynchronous operations.
- static udp v6();
+ void cancel(
+ implementation_type & impl);
@@ -64712,52 +63341,49 @@
-[endsect]
+[section:construct ip::resolver_service::construct]
+[indexterm2 construct..ip::resolver_service]
+Construct a new resolver implementation.
-[section:ip__unicast__hops ip::unicast::hops]
-[indexterm1 ip::unicast::hops]
-Socket option for time-to-live associated with outgoing unicast packets.
+ void construct(
+ implementation_type & impl);
- typedef implementation_defined hops;
+[endsect]
-Implements the IPPROTO\_IP/IP\_UNICAST\_TTL socket option.
+[section:destroy ip::resolver_service::destroy]
-[heading Examples]
-
-Setting the option:
+[indexterm2 destroy..ip::resolver_service]
+Destroy a resolver implementation.
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::unicast::hops option(4);
- socket.set_option(option);
+ void destroy(
+ implementation_type & impl);
+[endsect]
-Getting the current option value:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::ip::unicast::hops option;
- socket.get_option(option);
- int ttl = option.value();
+[section:endpoint_type ip::resolver_service::endpoint_type]
+[indexterm2 endpoint_type..ip::resolver_service]
+The endpoint type.
+ typedef InternetProtocol::endpoint endpoint_type;
[heading Requirements]
-[*Header: ][^boost/asio/ip/unicast.hpp]
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -64766,49 +63392,50 @@
-[section:ip__v6_only ip::v6_only]
+[section:get_io_service ip::resolver_service::get_io_service]
-[indexterm1 ip::v6_only]
-Socket option for determining whether an IPv6 socket supports IPv6 communication only.
+['Inherited from io_service.]
- typedef implementation_defined v6_only;
+[indexterm2 get_io_service..ip::resolver_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ boost::asio::io_service & get_io_service();
-Implements the IPPROTO\_IPV6/IP\_V6ONLY socket option.
-[heading Examples]
-
-Setting the option:
+[endsect]
+
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::ip::v6_only option(true);
- socket.set_option(option);
+[section:id ip::resolver_service::id]
+[indexterm2 id..ip::resolver_service]
+The unique service identifier.
+ static boost::asio::io_service::id id;
-Getting the current option value:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::ip::v6_only option;
- socket.get_option(option);
- bool v6_only = option.value();
+[endsect]
+
+
+
+[section:implementation_type ip::resolver_service::implementation_type]
+[indexterm2 implementation_type..ip::resolver_service]
+The type of a resolver implementation.
+ typedef implementation_defined implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/ip/v6_only.hpp]
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -64816,150 +63443,166 @@
[endsect]
-[section:is_match_condition is_match_condition]
+[section:iterator_type ip::resolver_service::iterator_type]
-Type trait used to determine whether a type can be used as a match condition function with read\_until and async\_read\_until.
+[indexterm2 iterator_type..ip::resolver_service]
+The iterator type.
- template<
- typename T>
- struct is_match_condition
+ typedef basic_resolver_iterator< InternetProtocol > iterator_type;
-[heading Data Members]
+[heading Types]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.is_match_condition.value [*value]]]
- [The value member is true if the type may be used as a match condition. ]
- ]
-
-]
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/read_until.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[section:value is_match_condition::value]
-
-[indexterm2 value..is_match_condition]
-The value member is true if the type may be used as a match condition.
+ [[link boost_asio.reference.ip__basic_resolver_iterator.difference_type [*difference_type]]]
+ [The type used for the distance between two iterators. ]
+
+ ]
- static const bool value;
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.iterator_category [*iterator_category]]]
+ [The iterator category. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.pointer [*pointer]]]
+ [The type of the result of applying operator->() to the iterator. ]
+
+ ]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.reference [*reference]]]
+ [The type of the result of applying operator*() to the iterator. ]
+
+ ]
-[endsect]
+ [
-[section:is_read_buffered is_read_buffered]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.value_type [*value_type]]]
+ [The type of the value pointed to by the iterator. ]
+
+ ]
+]
-The [link boost_asio.reference.is_read_buffered `is_read_buffered`] class is a traits class that may be used to determine whether a stream type supports buffering of read data.
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.basic_resolver_iterator [*basic_resolver_iterator]]]
+ [Default constructor creates an end iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.create [*create]]]
+ [Create an iterator from an addrinfo list returned by getaddrinfo.
- template<
- typename Stream>
- class is_read_buffered
+ Create an iterator from an endpoint, host name and service name. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator__star_ [*operator *]]]
+ [Dereference an iterator. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_plus__plus_ [*operator++]]]
+ [Increment operator (prefix).
+ Increment operator (postfix). ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_arrow_ [*operator->]]]
+ [Dereference an iterator. ]
+ ]
+
+]
-[heading Data Members]
+[heading Friends]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.is_read_buffered.value [*value]]]
- [The value member is true only if the Stream type supports buffering of read data. ]
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_not__eq_ [*operator!=]]]
+ [Test two iterators for inequality. ]
]
-
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver_iterator.operator_eq__eq_ [*operator==]]]
+ [Test two iterators for equality. ]
+ ]
+
]
-[heading Requirements]
-
-[*Header: ][^boost/asio/is_read_buffered.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[section:value is_read_buffered::value]
+The [link boost_asio.reference.ip__basic_resolver_iterator `ip::basic_resolver_iterator`] class template is used to define iterators over the results returned by a resolver.
-[indexterm2 value..is_read_buffered]
-The value member is true only if the Stream type supports buffering of read data.
+The iterator's value\_type, obtained when the iterator is dereferenced, is:
+ const basic_resolver_entry<InternetProtocol>
- static const bool value;
-[endsect]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-[endsect]
-[section:is_write_buffered is_write_buffered]
-The [link boost_asio.reference.is_write_buffered `is_write_buffered`] class is a traits class that may be used to determine whether a stream type supports buffering of written data.
+[heading Requirements]
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
- template<
- typename Stream>
- class is_write_buffered
+[*Convenience header: ][^boost/asio.hpp]
-[heading Data Members]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.is_write_buffered.value [*value]]]
- [The value member is true only if the Stream type supports buffering of written data. ]
- ]
-]
-[heading Requirements]
+[section:protocol_type ip::resolver_service::protocol_type]
-[*Header: ][^boost/asio/is_write_buffered.hpp]
+[indexterm2 protocol_type..ip::resolver_service]
+The protocol type.
-[*Convenience header: ][^boost/asio.hpp]
+ typedef InternetProtocol protocol_type;
-[section:value is_write_buffered::value]
-[indexterm2 value..is_write_buffered]
-The value member is true only if the Stream type supports buffering of written data.
+[heading Requirements]
- static const bool value;
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
-
-[section:local__basic_endpoint local::basic_endpoint]
-
+[section:query_type ip::resolver_service::query_type]
-Describes an endpoint for a UNIX socket.
+[indexterm2 query_type..ip::resolver_service]
+The query type.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class basic_endpoint
+ typedef basic_resolver_query< InternetProtocol > query_type;
[heading Types]
@@ -64968,15 +63611,15 @@
[
- [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.flags [*flags]]]
+ [A bitmask type (C++ Std \[lib.bitmask.types\]). ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint query. ]
]
@@ -64987,155 +63630,129 @@
[[Name][Description]]
[
- [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
- [Default constructor.
+ [[link boost_asio.reference.ip__basic_resolver_query.basic_resolver_query [*basic_resolver_query]]]
+ [Construct with specified service name for any protocol.
- Construct an endpoint using the specified path name.
+ Construct with specified service name for a given protocol.
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
- [Get the path associated with the endpoint.
+ Construct with specified host name and service name for any protocol.
- Set the path associated with the endpoint. ]
+ Construct with specified host name and service name for a given protocol. ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.hints [*hints]]]
+ [Get the hints associated with the query. ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.host_name [*host_name]]]
+ [Get the host name associated with the query. ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.service_name [*service_name]]]
+ [Get the service name associated with the query. ]
]
]
-[heading Friends]
+[heading Data Members]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.address_configured [*address_configured]]]
+ [Only return IPv4 addresses if a non-loopback IPv4 address is configured for the system. Only return IPv6 addresses if a non-loopback IPv6 address is configured for the system. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.all_matching [*all_matching]]]
+ [If used with v4_mapped, return all matching IPv6 and IPv4 addresses. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.canonical_name [*canonical_name]]]
+ [Determine the canonical name of the host specified in the query. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.numeric_host [*numeric_host]]]
+ [Host name should be treated as a numeric string defining an IPv4 or IPv6 address and no name resolution should be attempted. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.numeric_service [*numeric_service]]]
+ [Service name should be treated as a numeric string defining a port number and no name resolution should be attempted. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.passive [*passive]]]
+ [Indicate that returned endpoint is intended for use as a locally bound socket endpoint. ]
]
-
-]
-
-[heading Related Functions]
-[table
- [[Name][Description]]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
+ [[link boost_asio.reference.ip__basic_resolver_query.v4_mapped [*v4_mapped]]]
+ [If the query protocol family is specified as IPv6, return IPv4-mapped IPv6 addresses on finding no IPv6 addresses. ]
]
-
+
]
-The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+The [link boost_asio.reference.ip__basic_resolver_query `ip::basic_resolver_query`] class template describes a query that can be passed to a resolver.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[*Shared] [*objects:] Unsafe.
[heading Requirements]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+[*Header: ][^boost/asio/ip/resolver_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:basic_endpoint local::basic_endpoint::basic_endpoint]
-
-[indexterm2 basic_endpoint..local::basic_endpoint]
-Default constructor.
-
- ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload1 basic_endpoint]``();
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload1 more...]]``
+[endsect]
-Construct an endpoint using the specified path name.
+[section:resolve ip::resolver_service::resolve]
+[indexterm2 resolve..ip::resolver_service]
+Resolve a query to a list of entries.
- ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload2 basic_endpoint]``(
- const char * path_name);
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload2 more...]]``
- ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload3 basic_endpoint]``(
- const std::string & path_name);
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload3 more...]]``
+ iterator_type ``[link boost_asio.reference.ip__resolver_service.resolve.overload1 resolve]``(
+ implementation_type & impl,
+ const query_type & query,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__resolver_service.resolve.overload1 more...]]``
-Copy constructor.
+Resolve an endpoint to a list of entries.
- ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload4 basic_endpoint]``(
- const basic_endpoint & other);
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload4 more...]]``
+ iterator_type ``[link boost_asio.reference.ip__resolver_service.resolve.overload2 resolve]``(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ip__resolver_service.resolve.overload2 more...]]``
-[section:overload1 local::basic_endpoint::basic_endpoint (1 of 4 overloads)]
+[section:overload1 ip::resolver_service::resolve (1 of 2 overloads)]
-Default constructor.
+Resolve a query to a list of entries.
- basic_endpoint();
+ iterator_type resolve(
+ implementation_type & impl,
+ const query_type & query,
+ boost::system::error_code & ec);
@@ -65143,29 +63760,33 @@
-[section:overload2 local::basic_endpoint::basic_endpoint (2 of 4 overloads)]
+[section:overload2 ip::resolver_service::resolve (2 of 2 overloads)]
-Construct an endpoint using the specified path name.
+Resolve an endpoint to a list of entries.
- basic_endpoint(
- const char * path_name);
+ iterator_type resolve(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
[endsect]
+[endsect]
-[section:overload3 local::basic_endpoint::basic_endpoint (3 of 4 overloads)]
+[section:resolver_service ip::resolver_service::resolver_service]
-Construct an endpoint using the specified path name.
+[indexterm2 resolver_service..ip::resolver_service]
+Construct a new resolver service for the specified [link boost_asio.reference.io_service `io_service`].
- basic_endpoint(
- const std::string & path_name);
+ resolver_service(
+ boost::asio::io_service & io_service);
@@ -65173,92 +63794,4585 @@
-[section:overload4 local::basic_endpoint::basic_endpoint (4 of 4 overloads)]
+[endsect]
+[section:ip__tcp ip::tcp]
-Copy constructor.
+Encapsulates the flags needed for TCP.
- basic_endpoint(
- const basic_endpoint & other);
+ class tcp
-[endsect]
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[endsect]
+ [[link boost_asio.reference.ip__tcp.acceptor [*acceptor]]]
+ [The TCP acceptor type. ]
+
+ ]
+ [
-[section:capacity local::basic_endpoint::capacity]
+ [[link boost_asio.reference.ip__tcp.endpoint [*endpoint]]]
+ [The type of a TCP endpoint. ]
+
+ ]
-[indexterm2 capacity..local::basic_endpoint]
-Get the capacity of the endpoint in the native type.
+ [
+ [[link boost_asio.reference.ip__tcp.iostream [*iostream]]]
+ [The TCP iostream type. ]
+
+ ]
- std::size_t capacity() const;
+ [
+ [[link boost_asio.reference.ip__tcp.no_delay [*no_delay]]]
+ [Socket option for disabling the Nagle algorithm. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.ip__tcp.resolver [*resolver]]]
+ [The TCP resolver type. ]
+
+ ]
+ [
-[section:data local::basic_endpoint::data]
+ [[link boost_asio.reference.ip__tcp.socket [*socket]]]
+ [The TCP socket type. ]
+
+ ]
-[indexterm2 data..local::basic_endpoint]
-Get the underlying endpoint in the native type.
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
- data_type * ``[link boost_asio.reference.local__basic_endpoint.data.overload1 data]``();
+ [
+ [[link boost_asio.reference.ip__tcp.family [*family]]]
+ [Obtain an identifier for the protocol family. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__tcp.protocol [*protocol]]]
+ [Obtain an identifier for the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__tcp.type [*type]]]
+ [Obtain an identifier for the type of the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__tcp.v4 [*v4]]]
+ [Construct to represent the IPv4 TCP protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__tcp.v6 [*v6]]]
+ [Construct to represent the IPv6 TCP protocol. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__tcp.operator_not__eq_ [*operator!=]]]
+ [Compare two protocols for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__tcp.operator_eq__eq_ [*operator==]]]
+ [Compare two protocols for equality. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__tcp `ip::tcp`] class contains flags necessary for TCP sockets.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Safe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:acceptor ip::tcp::acceptor]
+
+[indexterm2 acceptor..ip::tcp]
+The TCP acceptor type.
+
+
+ typedef basic_socket_acceptor< tcp > acceptor;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.native_handle_type [*native_handle_type]]]
+ [The native representation of an acceptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of an acceptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.accept [*accept]]]
+ [Accept a new connection.
+
+ Accept a new connection and obtain the endpoint of the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.assign [*assign]]]
+ [Assigns an existing native acceptor to the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.async_accept [*async_accept]]]
+ [Start an asynchronous accept. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.basic_socket_acceptor [*basic_socket_acceptor]]]
+ [Construct an acceptor without opening it.
+
+ Construct an open acceptor.
+
+ Construct an acceptor opened on the given endpoint.
+
+ Construct a basic_socket_acceptor on an existing native acceptor.
+
+ Move-construct a basic_socket_acceptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.bind [*bind]]]
+ [Bind the acceptor to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.close [*close]]]
+ [Close the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_option [*get_option]]]
+ [Get an option from the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.io_control [*io_control]]]
+ [Perform an IO control command on the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.is_open [*is_open]]]
+ [Determine whether the acceptor is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.listen [*listen]]]
+ [Place the acceptor into the state where it will listen for new connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native acceptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native_handle [*native_handle]]]
+ [Get the native acceptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native acceptor implementation.
+
+ Sets the non-blocking mode of the native acceptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the acceptor.
+
+ Sets the non-blocking mode of the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.open [*open]]]
+ [Open the acceptor using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_socket_acceptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.set_option [*set_option]]]
+ [Set an option on the acceptor. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.basic_socket_acceptor `basic_socket_acceptor`] class template is used for accepting new socket connections.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+[heading Example]
+
+Opening a socket acceptor with the SO\_REUSEADDR option enabled:
+
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ 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();
+
+
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:endpoint ip::tcp::endpoint]
+
+[indexterm2 endpoint..ip::tcp]
+The type of a TCP endpoint.
+
+
+ typedef basic_endpoint< tcp > endpoint;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
+ [Get the IP address associated with the endpoint.
+
+ Set the IP address associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [Default constructor.
+
+ Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
+
+ Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+
+ Copy constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
+ [Get the port associated with the endpoint. The port number is always in the host's byte order.
+
+ Set the port associated with the endpoint. The port number is always in the host's byte order. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:family ip::tcp::family]
+
+[indexterm2 family..ip::tcp]
+Obtain an identifier for the protocol family.
+
+
+ int family() const;
+
+
+
+[endsect]
+
+
+
+[section:iostream ip::tcp::iostream]
+
+[indexterm2 iostream..ip::tcp]
+The TCP iostream type.
+
+
+ typedef basic_socket_iostream< tcp > iostream;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_iostream.duration_type [*duration_type]]]
+ [The duration type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_iostream.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_iostream.time_type [*time_type]]]
+ [The time type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.basic_socket_iostream [*basic_socket_iostream]]]
+ [Construct a basic_socket_iostream without establishing a connection.
+
+ Establish a connection to an endpoint corresponding to a resolver query. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.close [*close]]]
+ [Close the connection. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.connect [*connect]]]
+ [Establish a connection to an endpoint corresponding to a resolver query. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.error [*error]]]
+ [Get the last error associated with the stream. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.expires_at [*expires_at]]]
+ [Get the stream's expiry time as an absolute time.
+
+ Set the stream's expiry time as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
+
+ Set the stream's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.rdbuf [*rdbuf]]]
+ [Return a pointer to the underlying streambuf. ]
+ ]
+
+]
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:no_delay ip::tcp::no_delay]
+
+[indexterm2 no_delay..ip::tcp]
+Socket option for disabling the Nagle algorithm.
+
+
+ typedef implementation_defined no_delay;
+
+
+
+Implements the IPPROTO\_TCP/TCP\_NODELAY socket option.
+
+
+[heading Examples]
+
+Setting the option:
+
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::ip::tcp::no_delay option(true);
+ socket.set_option(option);
+
+
+
+
+
+Getting the current option value:
+
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::ip::tcp::no_delay option;
+ socket.get_option(option);
+ bool is_set = option.value();
+
+
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_not__eq_ ip::tcp::operator!=]
+
+[indexterm2 operator!=..ip::tcp]
+Compare two protocols for inequality.
+
+
+ friend bool operator!=(
+ const tcp & p1,
+ const tcp & p2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_eq__eq_ ip::tcp::operator==]
+
+[indexterm2 operator==..ip::tcp]
+Compare two protocols for equality.
+
+
+ friend bool operator==(
+ const tcp & p1,
+ const tcp & p2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:protocol ip::tcp::protocol]
+
+[indexterm2 protocol..ip::tcp]
+Obtain an identifier for the protocol.
+
+
+ int protocol() const;
+
+
+
+[endsect]
+
+
+
+[section:resolver ip::tcp::resolver]
+
+[indexterm2 resolver..ip::tcp]
+The TCP resolver type.
+
+
+ typedef basic_resolver< tcp > resolver;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
+ [The iterator type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
+ [The query type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
+ [Asynchronously perform forward resolution of a query to a list of entries.
+
+ Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the resolver. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
+ [Perform forward resolution of a query to a list of entries.
+
+ Perform reverse resolution of an endpoint to a list of entries. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:socket ip::tcp::socket]
+
+[indexterm2 socket..ip::tcp]
+The TCP socket type.
+
+
+ typedef basic_stream_socket< tcp > socket;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_socket is always the lowest layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.native_handle_type [*native_handle_type]]]
+ [The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_stream_socket.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.assign [*assign]]]
+ [Assign an existing native socket to the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_send [*async_send]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.basic_stream_socket [*basic_stream_socket]]]
+ [Construct a basic_stream_socket without opening it.
+
+ Construct and open a basic_stream_socket.
+
+ Construct a basic_stream_socket, opening it and binding it to the given local endpoint.
+
+ Construct a basic_stream_socket on an existing native socket.
+
+ Move-construct a basic_stream_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.bind [*bind]]]
+ [Bind the socket to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.close [*close]]]
+ [Close the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.connect [*connect]]]
+ [Connect the socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_option [*get_option]]]
+ [Get an option from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native_handle [*native_handle]]]
+ [Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.open [*open]]]
+ [Open the socket using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.operator_eq_ [*operator=]]]
+ [Move-assign a basic_stream_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.read_some [*read_some]]]
+ [Read some data from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.receive [*receive]]]
+ [Receive some data on the socket.
+
+ Receive some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.send [*send]]]
+ [Send some data on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.set_option [*set_option]]]
+ [Set an option on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.write_some [*write_some]]]
+ [Write some data to the socket. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] class template provides asynchronous and blocking stream-oriented socket functionality.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/tcp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:type ip::tcp::type]
+
+[indexterm2 type..ip::tcp]
+Obtain an identifier for the type of the protocol.
+
+
+ int type() const;
+
+
+
+[endsect]
+
+
+
+[section:v4 ip::tcp::v4]
+
+[indexterm2 v4..ip::tcp]
+Construct to represent the IPv4 TCP protocol.
+
+
+ static tcp v4();
+
+
+
+[endsect]
+
+
+
+[section:v6 ip::tcp::v6]
+
+[indexterm2 v6..ip::tcp]
+Construct to represent the IPv6 TCP protocol.
+
+
+ static tcp v6();
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:ip__udp ip::udp]
+
+
+Encapsulates the flags needed for UDP.
+
+
+ class udp
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__udp.endpoint [*endpoint]]]
+ [The type of a UDP endpoint. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__udp.resolver [*resolver]]]
+ [The UDP resolver type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__udp.socket [*socket]]]
+ [The UDP socket type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__udp.family [*family]]]
+ [Obtain an identifier for the protocol family. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__udp.protocol [*protocol]]]
+ [Obtain an identifier for the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__udp.type [*type]]]
+ [Obtain an identifier for the type of the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__udp.v4 [*v4]]]
+ [Construct to represent the IPv4 UDP protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__udp.v6 [*v6]]]
+ [Construct to represent the IPv6 UDP protocol. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__udp.operator_not__eq_ [*operator!=]]]
+ [Compare two protocols for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__udp.operator_eq__eq_ [*operator==]]]
+ [Compare two protocols for equality. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__udp `ip::udp`] class contains flags necessary for UDP sockets.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Safe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:endpoint ip::udp::endpoint]
+
+[indexterm2 endpoint..ip::udp]
+The type of a UDP endpoint.
+
+
+ typedef basic_endpoint< udp > endpoint;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.address [*address]]]
+ [Get the IP address associated with the endpoint.
+
+ Set the IP address associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [Default constructor.
+
+ Construct an endpoint using a port number, specified in the host's byte order. The IP address will be the any address (i.e. INADDR_ANY or in6addr_any). This constructor would typically be used for accepting new connections.
+
+ Construct an endpoint using a port number and an IP address. This constructor may be used for accepting connections on a specific interface or for making a connection to a remote endpoint.
+
+ Copy constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.port [*port]]]
+ [Get the port associated with the endpoint. The port number is always in the host's byte order.
+
+ Set the port associated with the endpoint. The port number is always in the host's byte order. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__basic_endpoint `ip::basic_endpoint`] class template describes an endpoint that may be associated with a particular socket.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:family ip::udp::family]
+
+[indexterm2 family..ip::udp]
+Obtain an identifier for the protocol family.
+
+
+ int family() const;
+
+
+
+[endsect]
+
+
+
+[section:operator_not__eq_ ip::udp::operator!=]
+
+[indexterm2 operator!=..ip::udp]
+Compare two protocols for inequality.
+
+
+ friend bool operator!=(
+ const udp & p1,
+ const udp & p2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_eq__eq_ ip::udp::operator==]
+
+[indexterm2 operator==..ip::udp]
+Compare two protocols for equality.
+
+
+ friend bool operator==(
+ const udp & p1,
+ const udp & p2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:protocol ip::udp::protocol]
+
+[indexterm2 protocol..ip::udp]
+Obtain an identifier for the protocol.
+
+
+ int protocol() const;
+
+
+
+[endsect]
+
+
+
+[section:resolver ip::udp::resolver]
+
+[indexterm2 resolver..ip::udp]
+The UDP resolver type.
+
+
+ typedef basic_resolver< udp > resolver;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.iterator [*iterator]]]
+ [The iterator type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.query [*query]]]
+ [The query type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ip__basic_resolver.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
+ [Asynchronously perform forward resolution of a query to a list of entries.
+
+ Asynchronously perform reverse resolution of an endpoint to a list of entries. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.basic_resolver [*basic_resolver]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the resolver. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
+ [Perform forward resolution of a query to a list of entries.
+
+ Perform reverse resolution of an endpoint to a list of entries. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ip__basic_resolver.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.ip__basic_resolver `ip::basic_resolver`] class template provides the ability to resolve a query to a list of endpoints.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:socket ip::udp::socket]
+
+[indexterm2 socket..ip::udp]
+The UDP socket type.
+
+
+ typedef basic_datagram_socket< udp > socket;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_socket is always the lowest layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.native_handle_type [*native_handle_type]]]
+ [The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.assign [*assign]]]
+ [Assign an existing native socket to the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_receive [*async_receive]]]
+ [Start an asynchronous receive on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_receive_from [*async_receive_from]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_send [*async_send]]]
+ [Start an asynchronous send on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_send_to [*async_send_to]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.basic_datagram_socket [*basic_datagram_socket]]]
+ [Construct a basic_datagram_socket without opening it.
+
+ Construct and open a basic_datagram_socket.
+
+ Construct a basic_datagram_socket, opening it and binding it to the given local endpoint.
+
+ Construct a basic_datagram_socket on an existing native socket.
+
+ Move-construct a basic_datagram_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.bind [*bind]]]
+ [Bind the socket to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.close [*close]]]
+ [Close the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.connect [*connect]]]
+ [Connect the socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_option [*get_option]]]
+ [Get an option from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native_handle [*native_handle]]]
+ [Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.open [*open]]]
+ [Open the socket using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.operator_eq_ [*operator=]]]
+ [Move-assign a basic_datagram_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.receive [*receive]]]
+ [Receive some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.receive_from [*receive_from]]]
+ [Receive a datagram with the endpoint of the sender. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.send [*send]]]
+ [Send some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.send_to [*send_to]]]
+ [Send a datagram to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.set_option [*set_option]]]
+ [Set an option on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class template provides asynchronous and blocking datagram-oriented socket functionality.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/udp.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:type ip::udp::type]
+
+[indexterm2 type..ip::udp]
+Obtain an identifier for the type of the protocol.
+
+
+ int type() const;
+
+
+
+[endsect]
+
+
+
+[section:v4 ip::udp::v4]
+
+[indexterm2 v4..ip::udp]
+Construct to represent the IPv4 UDP protocol.
+
+
+ static udp v4();
+
+
+
+[endsect]
+
+
+
+[section:v6 ip::udp::v6]
+
+[indexterm2 v6..ip::udp]
+Construct to represent the IPv6 UDP protocol.
+
+
+ static udp v6();
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+
+[section:ip__unicast__hops ip::unicast::hops]
+
+[indexterm1 ip::unicast::hops]
+Socket option for time-to-live associated with outgoing unicast packets.
+
+
+ typedef implementation_defined hops;
+
+
+
+Implements the IPPROTO\_IP/IP\_UNICAST\_TTL socket option.
+
+
+[heading Examples]
+
+Setting the option:
+
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::unicast::hops option(4);
+ socket.set_option(option);
+
+
+
+
+
+Getting the current option value:
+
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::ip::unicast::hops option;
+ socket.get_option(option);
+ int ttl = option.value();
+
+
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/unicast.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:ip__v6_only ip::v6_only]
+
+[indexterm1 ip::v6_only]
+Socket option for determining whether an IPv6 socket supports IPv6 communication only.
+
+
+ typedef implementation_defined v6_only;
+
+
+
+Implements the IPPROTO\_IPV6/IP\_V6ONLY socket option.
+
+
+[heading Examples]
+
+Setting the option:
+
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::ip::v6_only option(true);
+ socket.set_option(option);
+
+
+
+
+
+Getting the current option value:
+
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::ip::v6_only option;
+ socket.get_option(option);
+ bool v6_only = option.value();
+
+
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/ip/v6_only.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:is_match_condition is_match_condition]
+
+
+Type trait used to determine whether a type can be used as a match condition function with read\_until and async\_read\_until.
+
+
+ template<
+ typename T>
+ struct is_match_condition
+
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.is_match_condition.value [*value]]]
+ [The value member is true if the type may be used as a match condition. ]
+ ]
+
+]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/read_until.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:value is_match_condition::value]
+
+[indexterm2 value..is_match_condition]
+The value member is true if the type may be used as a match condition.
+
+
+ static const bool value;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:is_read_buffered is_read_buffered]
+
+
+The [link boost_asio.reference.is_read_buffered `is_read_buffered`] class is a traits class that may be used to determine whether a stream type supports buffering of read data.
+
+
+ template<
+ typename Stream>
+ class is_read_buffered
+
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.is_read_buffered.value [*value]]]
+ [The value member is true only if the Stream type supports buffering of read data. ]
+ ]
+
+]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/is_read_buffered.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:value is_read_buffered::value]
+
+[indexterm2 value..is_read_buffered]
+The value member is true only if the Stream type supports buffering of read data.
+
+
+ static const bool value;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:is_write_buffered is_write_buffered]
+
+
+The [link boost_asio.reference.is_write_buffered `is_write_buffered`] class is a traits class that may be used to determine whether a stream type supports buffering of written data.
+
+
+ template<
+ typename Stream>
+ class is_write_buffered
+
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.is_write_buffered.value [*value]]]
+ [The value member is true only if the Stream type supports buffering of written data. ]
+ ]
+
+]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/is_write_buffered.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:value is_write_buffered::value]
+
+[indexterm2 value..is_write_buffered]
+The value member is true only if the Stream type supports buffering of written data.
+
+
+ static const bool value;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:local__basic_endpoint local::basic_endpoint]
+
+
+Describes an endpoint for a UNIX socket.
+
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class basic_endpoint
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [Default constructor.
+
+ Construct an endpoint using the specified path name.
+
+ Copy constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
+ [Get the path associated with the endpoint.
+
+ Set the path associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+[section:basic_endpoint local::basic_endpoint::basic_endpoint]
+
+[indexterm2 basic_endpoint..local::basic_endpoint]
+Default constructor.
+
+
+ ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload1 basic_endpoint]``();
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload1 more...]]``
+
+
+Construct an endpoint using the specified path name.
+
+
+ ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload2 basic_endpoint]``(
+ const char * path_name);
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload2 more...]]``
+
+ ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload3 basic_endpoint]``(
+ const std::string & path_name);
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload3 more...]]``
+
+
+Copy constructor.
+
+
+ ``[link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload4 basic_endpoint]``(
+ const basic_endpoint & other);
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.basic_endpoint.overload4 more...]]``
+
+
+[section:overload1 local::basic_endpoint::basic_endpoint (1 of 4 overloads)]
+
+
+Default constructor.
+
+
+ basic_endpoint();
+
+
+
+[endsect]
+
+
+
+[section:overload2 local::basic_endpoint::basic_endpoint (2 of 4 overloads)]
+
+
+Construct an endpoint using the specified path name.
+
+
+ basic_endpoint(
+ const char * path_name);
+
+
+
+[endsect]
+
+
+
+[section:overload3 local::basic_endpoint::basic_endpoint (3 of 4 overloads)]
+
+
+Construct an endpoint using the specified path name.
+
+
+ basic_endpoint(
+ const std::string & path_name);
+
+
+
+[endsect]
+
+
+
+[section:overload4 local::basic_endpoint::basic_endpoint (4 of 4 overloads)]
+
+
+Copy constructor.
+
+
+ basic_endpoint(
+ const basic_endpoint & other);
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:capacity local::basic_endpoint::capacity]
+
+[indexterm2 capacity..local::basic_endpoint]
+Get the capacity of the endpoint in the native type.
+
+
+ std::size_t capacity() const;
+
+
+
+[endsect]
+
+
+[section:data local::basic_endpoint::data]
+
+[indexterm2 data..local::basic_endpoint]
+Get the underlying endpoint in the native type.
+
+
+ data_type * ``[link boost_asio.reference.local__basic_endpoint.data.overload1 data]``();
`` [''''»''' [link boost_asio.reference.local__basic_endpoint.data.overload1 more...]]``
- const data_type * ``[link boost_asio.reference.local__basic_endpoint.data.overload2 data]``() const;
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.data.overload2 more...]]``
+ const data_type * ``[link boost_asio.reference.local__basic_endpoint.data.overload2 data]``() const;
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.data.overload2 more...]]``
+
+
+[section:overload1 local::basic_endpoint::data (1 of 2 overloads)]
+
+
+Get the underlying endpoint in the native type.
+
+
+ data_type * data();
+
+
+
+[endsect]
+
+
+
+[section:overload2 local::basic_endpoint::data (2 of 2 overloads)]
+
+
+Get the underlying endpoint in the native type.
+
+
+ const data_type * data() const;
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:data_type local::basic_endpoint::data_type]
+
+[indexterm2 data_type..local::basic_endpoint]
+The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer.
+
+
+ typedef implementation_defined data_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_not__eq_ local::basic_endpoint::operator!=]
+
+[indexterm2 operator!=..local::basic_endpoint]
+Compare two endpoints for inequality.
+
+
+ friend bool operator!=(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_lt_ local::basic_endpoint::operator<]
+
+[indexterm2 operator<..local::basic_endpoint]
+Compare endpoints for ordering.
+
+
+ friend bool operator<(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_lt__lt_ local::basic_endpoint::operator<<]
+
+[indexterm2 operator<<..local::basic_endpoint]
+Output an endpoint as a string.
+
+
+ std::basic_ostream< Elem, Traits > & operator<<(
+ std::basic_ostream< Elem, Traits > & os,
+ const basic_endpoint< Protocol > & endpoint);
+
+
+Used to output a human-readable string for a specified endpoint.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[os][The output stream to which the string will be written.]]
+
+[[endpoint][The endpoint to be written.]]
+
+]
+
+
+[heading Return Value]
+
+The output stream.
+
+
+
+
+[endsect]
+
+
+
+[section:operator_lt__eq_ local::basic_endpoint::operator<=]
+
+[indexterm2 operator<=..local::basic_endpoint]
+Compare endpoints for ordering.
+
+
+ friend bool operator<=(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_eq_ local::basic_endpoint::operator=]
+
+[indexterm2 operator=..local::basic_endpoint]
+Assign from another endpoint.
+
+
+ basic_endpoint & operator=(
+ const basic_endpoint & other);
+
+
+
+[endsect]
+
+
+
+[section:operator_eq__eq_ local::basic_endpoint::operator==]
+
+[indexterm2 operator==..local::basic_endpoint]
+Compare two endpoints for equality.
+
+
+ friend bool operator==(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_gt_ local::basic_endpoint::operator>]
+
+[indexterm2 operator>..local::basic_endpoint]
+Compare endpoints for ordering.
+
+
+ friend bool operator>(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_gt__eq_ local::basic_endpoint::operator>=]
+
+[indexterm2 operator>=..local::basic_endpoint]
+Compare endpoints for ordering.
+
+
+ friend bool operator>=(
+ const basic_endpoint< Protocol > & e1,
+ const basic_endpoint< Protocol > & e2);
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:path local::basic_endpoint::path]
+
+[indexterm2 path..local::basic_endpoint]
+Get the path associated with the endpoint.
+
+
+ std::string ``[link boost_asio.reference.local__basic_endpoint.path.overload1 path]``() const;
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload1 more...]]``
+
+
+Set the path associated with the endpoint.
+
+
+ void ``[link boost_asio.reference.local__basic_endpoint.path.overload2 path]``(
+ const char * p);
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload2 more...]]``
+
+ void ``[link boost_asio.reference.local__basic_endpoint.path.overload3 path]``(
+ const std::string & p);
+ `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload3 more...]]``
+
+
+[section:overload1 local::basic_endpoint::path (1 of 3 overloads)]
+
+
+Get the path associated with the endpoint.
+
+
+ std::string path() const;
+
+
+
+[endsect]
+
+
+
+[section:overload2 local::basic_endpoint::path (2 of 3 overloads)]
+
+
+Set the path associated with the endpoint.
+
+
+ void path(
+ const char * p);
+
+
+
+[endsect]
+
+
+
+[section:overload3 local::basic_endpoint::path (3 of 3 overloads)]
+
+
+Set the path associated with the endpoint.
+
+
+ void path(
+ const std::string & p);
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:protocol local::basic_endpoint::protocol]
+
+[indexterm2 protocol..local::basic_endpoint]
+The protocol associated with the endpoint.
+
+
+ protocol_type protocol() const;
+
+
+
+[endsect]
+
+
+
+[section:protocol_type local::basic_endpoint::protocol_type]
+
+[indexterm2 protocol_type..local::basic_endpoint]
+The protocol type associated with the endpoint.
+
+
+ typedef Protocol protocol_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:resize local::basic_endpoint::resize]
+
+[indexterm2 resize..local::basic_endpoint]
+Set the underlying size of the endpoint in the native type.
+
+
+ void resize(
+ std::size_t new_size);
+
+
+
+[endsect]
+
+
+
+[section:size local::basic_endpoint::size]
+
+[indexterm2 size..local::basic_endpoint]
+Get the underlying size of the endpoint in the native type.
+
+
+ std::size_t size() const;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:local__connect_pair local::connect_pair]
+
+[indexterm1 local::connect_pair]
+Create a pair of connected sockets.
+
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService1]``,
+ typename ``[link boost_asio.reference.SocketService SocketService2]``>
+ void ``[link boost_asio.reference.local__connect_pair.overload1 connect_pair]``(
+ basic_socket< Protocol, SocketService1 > & socket1,
+ basic_socket< Protocol, SocketService2 > & socket2);
+ `` [''''»''' [link boost_asio.reference.local__connect_pair.overload1 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService1]``,
+ typename ``[link boost_asio.reference.SocketService SocketService2]``>
+ boost::system::error_code ``[link boost_asio.reference.local__connect_pair.overload2 connect_pair]``(
+ basic_socket< Protocol, SocketService1 > & socket1,
+ basic_socket< Protocol, SocketService2 > & socket2,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.local__connect_pair.overload2 more...]]``
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/connect_pair.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:overload1 local::connect_pair (1 of 2 overloads)]
+
+
+Create a pair of connected sockets.
+
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService1]``,
+ typename ``[link boost_asio.reference.SocketService SocketService2]``>
+ void connect_pair(
+ basic_socket< Protocol, SocketService1 > & socket1,
+ basic_socket< Protocol, SocketService2 > & socket2);
+
+
+
+[endsect]
+
+
+
+[section:overload2 local::connect_pair (2 of 2 overloads)]
+
+
+Create a pair of connected sockets.
+
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``,
+ typename ``[link boost_asio.reference.SocketService SocketService1]``,
+ typename ``[link boost_asio.reference.SocketService SocketService2]``>
+ boost::system::error_code connect_pair(
+ basic_socket< Protocol, SocketService1 > & socket1,
+ basic_socket< Protocol, SocketService2 > & socket2,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+[endsect]
+
+[section:local__datagram_protocol local::datagram_protocol]
+
+
+Encapsulates the flags needed for datagram-oriented UNIX sockets.
+
+
+ class datagram_protocol
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.local__datagram_protocol.endpoint [*endpoint]]]
+ [The type of a UNIX domain endpoint. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__datagram_protocol.socket [*socket]]]
+ [The UNIX domain socket type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__datagram_protocol.family [*family]]]
+ [Obtain an identifier for the protocol family. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__datagram_protocol.protocol [*protocol]]]
+ [Obtain an identifier for the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__datagram_protocol.type [*type]]]
+ [Obtain an identifier for the type of the protocol. ]
+ ]
+
+]
+
+The [link boost_asio.reference.local__datagram_protocol `local::datagram_protocol`] class contains flags necessary for datagram-oriented UNIX domain sockets.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Safe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/datagram_protocol.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:endpoint local::datagram_protocol::endpoint]
+
+[indexterm2 endpoint..local::datagram_protocol]
+The type of a UNIX domain endpoint.
+
+
+ typedef basic_endpoint< datagram_protocol > endpoint;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [Default constructor.
+
+ Construct an endpoint using the specified path name.
+
+ Copy constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
+ [Get the path associated with the endpoint.
+
+ Set the path associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/datagram_protocol.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:family local::datagram_protocol::family]
+
+[indexterm2 family..local::datagram_protocol]
+Obtain an identifier for the protocol family.
+
+
+ int family() const;
+
+
+
+[endsect]
+
+
+
+[section:protocol local::datagram_protocol::protocol]
+
+[indexterm2 protocol..local::datagram_protocol]
+Obtain an identifier for the protocol.
+
+
+ int protocol() const;
+
+
+
+[endsect]
+
+
+
+[section:socket local::datagram_protocol::socket]
+
+[indexterm2 socket..local::datagram_protocol]
+The UNIX domain socket type.
+
+
+ typedef basic_datagram_socket< datagram_protocol > socket;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_socket is always the lowest layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.native_handle_type [*native_handle_type]]]
+ [The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_datagram_socket.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.assign [*assign]]]
+ [Assign an existing native socket to the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_receive [*async_receive]]]
+ [Start an asynchronous receive on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_receive_from [*async_receive_from]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_send [*async_send]]]
+ [Start an asynchronous send on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.async_send_to [*async_send_to]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.basic_datagram_socket [*basic_datagram_socket]]]
+ [Construct a basic_datagram_socket without opening it.
+
+ Construct and open a basic_datagram_socket.
+
+ Construct a basic_datagram_socket, opening it and binding it to the given local endpoint.
+
+ Construct a basic_datagram_socket on an existing native socket.
+
+ Move-construct a basic_datagram_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.bind [*bind]]]
+ [Bind the socket to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.close [*close]]]
+ [Close the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.connect [*connect]]]
+ [Connect the socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_option [*get_option]]]
+ [Get an option from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native_handle [*native_handle]]]
+ [Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.open [*open]]]
+ [Open the socket using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.operator_eq_ [*operator=]]]
+ [Move-assign a basic_datagram_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.receive [*receive]]]
+ [Receive some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.receive_from [*receive_from]]]
+ [Receive a datagram with the endpoint of the sender. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.send [*send]]]
+ [Send some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.send_to [*send_to]]]
+ [Send a datagram to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.set_option [*set_option]]]
+ [Set an option on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_datagram_socket.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class template provides asynchronous and blocking datagram-oriented socket functionality.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/datagram_protocol.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:type local::datagram_protocol::type]
+
+[indexterm2 type..local::datagram_protocol]
+Obtain an identifier for the type of the protocol.
+
+
+ int type() const;
+
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:local__stream_protocol local::stream_protocol]
+
+
+Encapsulates the flags needed for stream-oriented UNIX sockets.
+
+
+ class stream_protocol
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.local__stream_protocol.acceptor [*acceptor]]]
+ [The UNIX domain acceptor type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__stream_protocol.endpoint [*endpoint]]]
+ [The type of a UNIX domain endpoint. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__stream_protocol.iostream [*iostream]]]
+ [The UNIX domain iostream type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.local__stream_protocol.socket [*socket]]]
+ [The UNIX domain socket type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__stream_protocol.family [*family]]]
+ [Obtain an identifier for the protocol family. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__stream_protocol.protocol [*protocol]]]
+ [Obtain an identifier for the protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__stream_protocol.type [*type]]]
+ [Obtain an identifier for the type of the protocol. ]
+ ]
+
+]
+
+The [link boost_asio.reference.local__stream_protocol `local::stream_protocol`] class contains flags necessary for stream-oriented UNIX domain sockets.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Safe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/local/stream_protocol.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:acceptor local::stream_protocol::acceptor]
+
+[indexterm2 acceptor..local::stream_protocol]
+The UNIX domain acceptor type.
+
+
+ typedef basic_socket_acceptor< stream_protocol > acceptor;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.native_handle_type [*native_handle_type]]]
+ [The native representation of an acceptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of an acceptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.basic_socket_acceptor.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.accept [*accept]]]
+ [Accept a new connection.
+
+ Accept a new connection and obtain the endpoint of the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.assign [*assign]]]
+ [Assigns an existing native acceptor to the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.async_accept [*async_accept]]]
+ [Start an asynchronous accept. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.basic_socket_acceptor [*basic_socket_acceptor]]]
+ [Construct an acceptor without opening it.
+
+ Construct an open acceptor.
+
+ Construct an acceptor opened on the given endpoint.
+
+ Construct a basic_socket_acceptor on an existing native acceptor.
+
+ Move-construct a basic_socket_acceptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.bind [*bind]]]
+ [Bind the acceptor to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.close [*close]]]
+ [Close the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_option [*get_option]]]
+ [Get an option from the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.io_control [*io_control]]]
+ [Perform an IO control command on the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.is_open [*is_open]]]
+ [Determine whether the acceptor is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.listen [*listen]]]
+ [Place the acceptor into the state where it will listen for new connections. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native acceptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native_handle [*native_handle]]]
+ [Get the native acceptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native acceptor implementation.
+ Sets the non-blocking mode of the native acceptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the acceptor.
-[section:overload1 local::basic_endpoint::data (1 of 2 overloads)]
+ Sets the non-blocking mode of the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.open [*open]]]
+ [Open the acceptor using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_socket_acceptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.set_option [*set_option]]]
+ [Set an option on the acceptor. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-Get the underlying endpoint in the native type.
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+[heading Data Members]
+[table
+ [[Name][Description]]
- data_type * data();
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
+]
-[section:overload2 local::basic_endpoint::data (2 of 2 overloads)]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-Get the underlying endpoint in the native type.
+ [
+ [[link boost_asio.reference.basic_socket_acceptor.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
- const data_type * data() const;
+The [link boost_asio.reference.basic_socket_acceptor `basic_socket_acceptor`] class template is used for accepting new socket connections.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[endsect]
+[*Shared] [*objects:] Unsafe.
-[endsect]
+[heading Example]
+
+Opening a socket acceptor with the SO\_REUSEADDR option enabled:
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ 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();
-[section:data_type local::basic_endpoint::data_type]
-[indexterm2 data_type..local::basic_endpoint]
-The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer.
- typedef implementation_defined data_type;
[heading Requirements]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+[*Header: ][^boost/asio/local/stream_protocol.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -65267,42 +68381,150 @@
-[section:operator_not__eq_ local::basic_endpoint::operator!=]
+[section:endpoint local::stream_protocol::endpoint]
-[indexterm2 operator!=..local::basic_endpoint]
-Compare two endpoints for inequality.
+[indexterm2 endpoint..local::stream_protocol]
+The type of a UNIX domain endpoint.
- friend bool operator!=(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
+ typedef basic_endpoint< stream_protocol > endpoint;
-[heading Requirements]
+[heading Types]
+[table
+ [[Name][Description]]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+ [
-[*Convenience header: ][^boost/asio.hpp]
+ [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
+ [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
+ [The protocol type associated with the endpoint. ]
+
+ ]
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
+ [Default constructor.
-[section:operator_lt_ local::basic_endpoint::operator<]
+ Construct an endpoint using the specified path name.
+
+ Copy constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
+ [Get the capacity of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
+ [Get the underlying endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
+ [Assign from another endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
+ [Get the path associated with the endpoint.
+
+ Set the path associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
+ [The protocol associated with the endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
+ [Set the underlying size of the endpoint in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
+ [Get the underlying size of the endpoint in the native type. ]
+ ]
+
+]
+
+[heading Friends]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
+ [Compare two endpoints for inequality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
+ [Compare two endpoints for equality. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
+ [Compare endpoints for ordering. ]
+ ]
+
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
+ [Output an endpoint as a string. ]
+ ]
+
+]
+
+The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
-[indexterm2 operator<..local::basic_endpoint]
-Compare endpoints for ordering.
- friend bool operator<(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
[heading Requirements]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+[*Header: ][^boost/asio/local/stream_protocol.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -65311,57 +68533,107 @@
-[section:operator_lt__lt_ local::basic_endpoint::operator<<]
+[section:family local::stream_protocol::family]
-[indexterm2 operator<<..local::basic_endpoint]
-Output an endpoint as a string.
+[indexterm2 family..local::stream_protocol]
+Obtain an identifier for the protocol family.
- std::basic_ostream< Elem, Traits > & operator<<(
- std::basic_ostream< Elem, Traits > & os,
- const basic_endpoint< Protocol > & endpoint);
+ int family() const;
-Used to output a human-readable string for a specified endpoint.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[os][The output stream to which the string will be written.]]
-[[endpoint][The endpoint to be written.]]
+[section:iostream local::stream_protocol::iostream]
-]
+[indexterm2 iostream..local::stream_protocol]
+The UNIX domain iostream type.
-[heading Return Value]
-
-The output stream.
+ typedef basic_socket_iostream< stream_protocol > iostream;
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_socket_iostream.duration_type [*duration_type]]]
+ [The duration type. ]
+
+ ]
+ [
+ [[link boost_asio.reference.basic_socket_iostream.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
-[section:operator_lt__eq_ local::basic_endpoint::operator<=]
+ [
-[indexterm2 operator<=..local::basic_endpoint]
-Compare endpoints for ordering.
+ [[link boost_asio.reference.basic_socket_iostream.time_type [*time_type]]]
+ [The time type. ]
+
+ ]
+
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
- friend bool operator<=(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
+ [
+ [[link boost_asio.reference.basic_socket_iostream.basic_socket_iostream [*basic_socket_iostream]]]
+ [Construct a basic_socket_iostream without establishing a connection.
+
+ Establish a connection to an endpoint corresponding to a resolver query. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.close [*close]]]
+ [Close the connection. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.connect [*connect]]]
+ [Establish a connection to an endpoint corresponding to a resolver query. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.error [*error]]]
+ [Get the last error associated with the stream. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.expires_at [*expires_at]]]
+ [Get the stream's expiry time as an absolute time.
+
+ Set the stream's expiry time as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
+
+ Set the stream's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_socket_iostream.rdbuf [*rdbuf]]]
+ [Return a pointer to the underlying streambuf. ]
+ ]
+
+]
[heading Requirements]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+[*Header: ][^boost/asio/local/stream_protocol.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -65370,14 +68642,13 @@
-[section:operator_eq_ local::basic_endpoint::operator=]
+[section:protocol local::stream_protocol::protocol]
-[indexterm2 operator=..local::basic_endpoint]
-Assign from another endpoint.
+[indexterm2 protocol..local::stream_protocol]
+Obtain an identifier for the protocol.
- basic_endpoint & operator=(
- const basic_endpoint & other);
+ int protocol() const;
@@ -65385,461 +68656,671 @@
-[section:operator_eq__eq_ local::basic_endpoint::operator==]
+[section:socket local::stream_protocol::socket]
-[indexterm2 operator==..local::basic_endpoint]
-Compare two endpoints for equality.
+[indexterm2 socket..local::stream_protocol]
+The UNIX domain socket type.
- friend bool operator==(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
+ typedef basic_stream_socket< stream_protocol > socket;
-[heading Requirements]
+[heading Types]
+[table
+ [[Name][Description]]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+ [
-[*Convenience header: ][^boost/asio.hpp]
+ [[link boost_asio.reference.basic_stream_socket.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_stream_socket.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+
+ ]
+ [
+ [[link boost_asio.reference.basic_stream_socket.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
+
+ ]
-[section:operator_gt_ local::basic_endpoint::operator>]
+ [
-[indexterm2 operator>..local::basic_endpoint]
-Compare endpoints for ordering.
+ [[link boost_asio.reference.basic_stream_socket.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
+ [
- friend bool operator>(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
+ [[link boost_asio.reference.basic_stream_socket.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+ [
-[heading Requirements]
+ [[link boost_asio.reference.basic_stream_socket.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+ [
-[*Convenience header: ][^boost/asio.hpp]
+ [[link boost_asio.reference.basic_stream_socket.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_stream_socket.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
+ [
+ [[link boost_asio.reference.basic_stream_socket.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
-[section:operator_gt__eq_ local::basic_endpoint::operator>=]
+ [
-[indexterm2 operator>=..local::basic_endpoint]
-Compare endpoints for ordering.
+ [[link boost_asio.reference.basic_stream_socket.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_socket is always the lowest layer. ]
+
+ ]
+ [
- friend bool operator>=(
- const basic_endpoint< Protocol > & e1,
- const basic_endpoint< Protocol > & e2);
+ [[link boost_asio.reference.basic_stream_socket.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
+ [
-[heading Requirements]
+ [[link boost_asio.reference.basic_stream_socket.native_handle_type [*native_handle_type]]]
+ [The native representation of a socket. ]
+
+ ]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+ [
-[*Convenience header: ][^boost/asio.hpp]
+ [[link boost_asio.reference.basic_stream_socket.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_stream_socket.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+ [
-[section:path local::basic_endpoint::path]
+ [[link boost_asio.reference.basic_stream_socket.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
-[indexterm2 path..local::basic_endpoint]
-Get the path associated with the endpoint.
+ [
+ [[link boost_asio.reference.basic_stream_socket.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
- std::string ``[link boost_asio.reference.local__basic_endpoint.path.overload1 path]``() const;
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload1 more...]]``
+ [
+ [[link boost_asio.reference.basic_stream_socket.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
-Set the path associated with the endpoint.
+ [
+ [[link boost_asio.reference.basic_stream_socket.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
- void ``[link boost_asio.reference.local__basic_endpoint.path.overload2 path]``(
- const char * p);
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload2 more...]]``
+ [
- void ``[link boost_asio.reference.local__basic_endpoint.path.overload3 path]``(
- const std::string & p);
- `` [''''»''' [link boost_asio.reference.local__basic_endpoint.path.overload3 more...]]``
+ [[link boost_asio.reference.basic_stream_socket.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+ [
-[section:overload1 local::basic_endpoint::path (1 of 3 overloads)]
+ [[link boost_asio.reference.basic_stream_socket.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
+ [
-Get the path associated with the endpoint.
+ [[link boost_asio.reference.basic_stream_socket.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+ [
- std::string path() const;
+ [[link boost_asio.reference.basic_stream_socket.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_stream_socket.assign [*assign]]]
+ [Assign an existing native socket to the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_send [*async_send]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.basic_stream_socket [*basic_stream_socket]]]
+ [Construct a basic_stream_socket without opening it.
+ Construct and open a basic_stream_socket.
+ Construct a basic_stream_socket, opening it and binding it to the given local endpoint.
-[section:overload2 local::basic_endpoint::path (2 of 3 overloads)]
+ Construct a basic_stream_socket on an existing native socket.
+ Move-construct a basic_stream_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.bind [*bind]]]
+ [Bind the socket to the given local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.close [*close]]]
+ [Close the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.connect [*connect]]]
+ [Connect the socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_option [*get_option]]]
+ [Get an option from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
-Set the path associated with the endpoint.
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native_handle [*native_handle]]]
+ [Get the native socket representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
- void path(
- const char * p);
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.open [*open]]]
+ [Open the socket using the specified protocol. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.operator_eq_ [*operator=]]]
+ [Move-assign a basic_stream_socket from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.read_some [*read_some]]]
+ [Read some data from the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.receive [*receive]]]
+ [Receive some data on the socket.
+ Receive some data on a connected socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.send [*send]]]
+ [Send some data on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.set_option [*set_option]]]
+ [Set an option on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.write_some [*write_some]]]
+ [Write some data to the socket. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_stream_socket.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_stream_socket.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
-[section:overload3 local::basic_endpoint::path (3 of 3 overloads)]
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
+ ]
-Set the path associated with the endpoint.
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
+ ]
+ [
+ [[link boost_asio.reference.basic_stream_socket.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
+ ]
- void path(
- const std::string & p);
+]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_stream_socket.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_stream_socket.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
-[endsect]
+The [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] class template provides asynchronous and blocking stream-oriented socket functionality.
-[section:protocol local::basic_endpoint::protocol]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[indexterm2 protocol..local::basic_endpoint]
-The protocol associated with the endpoint.
+[*Shared] [*objects:] Unsafe.
- protocol_type protocol() const;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/local/stream_protocol.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:protocol_type local::basic_endpoint::protocol_type]
-[indexterm2 protocol_type..local::basic_endpoint]
-The protocol type associated with the endpoint.
+[endsect]
- typedef Protocol protocol_type;
+[section:type local::stream_protocol::type]
+[indexterm2 type..local::stream_protocol]
+Obtain an identifier for the type of the protocol.
-[heading Requirements]
-[*Header: ][^boost/asio/local/basic_endpoint.hpp]
+ int type() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:resize local::basic_endpoint::resize]
+[endsect]
-[indexterm2 resize..local::basic_endpoint]
-Set the underlying size of the endpoint in the native type.
+[section:mutable_buffer mutable_buffer]
- void resize(
- std::size_t new_size);
+Holds a buffer that can be modified.
+ class mutable_buffer
-[endsect]
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
+ [Construct an empty buffer.
-[section:size local::basic_endpoint::size]
+ Construct a buffer to represent a given memory range. ]
+ ]
+
+]
-[indexterm2 size..local::basic_endpoint]
-Get the underlying size of the endpoint in the native type.
+[heading Related Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
+ [Create a new modifiable buffer that is offset from the start of another. ]
+ ]
+
+]
- std::size_t size() const;
+The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
+[heading Accessing Buffer Contents]
+
-[endsect]
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
-[endsect]
-[section:local__connect_pair local::connect_pair]
+ boost::asio::mutable_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
-[indexterm1 local::connect_pair]
-Create a pair of connected sockets.
-
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService1]``,
- typename ``[link boost_asio.reference.SocketService SocketService2]``>
- void ``[link boost_asio.reference.local__connect_pair.overload1 connect_pair]``(
- basic_socket< Protocol, SocketService1 > & socket1,
- basic_socket< Protocol, SocketService2 > & socket2);
- `` [''''»''' [link boost_asio.reference.local__connect_pair.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService1]``,
- typename ``[link boost_asio.reference.SocketService SocketService2]``>
- boost::system::error_code ``[link boost_asio.reference.local__connect_pair.overload2 connect_pair]``(
- basic_socket< Protocol, SocketService1 > & socket1,
- basic_socket< Protocol, SocketService2 > & socket2,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.local__connect_pair.overload2 more...]]``
+
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
[heading Requirements]
-[*Header: ][^boost/asio/local/connect_pair.hpp]
+[*Header: ][^boost/asio/buffer.hpp]
[*Convenience header: ][^boost/asio.hpp]
+[section:mutable_buffer mutable_buffer::mutable_buffer]
-[section:overload1 local::connect_pair (1 of 2 overloads)]
-
-
-Create a pair of connected sockets.
+[indexterm2 mutable_buffer..mutable_buffer]
+Construct an empty buffer.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService1]``,
- typename ``[link boost_asio.reference.SocketService SocketService2]``>
- void connect_pair(
- basic_socket< Protocol, SocketService1 > & socket1,
- basic_socket< Protocol, SocketService2 > & socket2);
+ ``[link boost_asio.reference.mutable_buffer.mutable_buffer.overload1 mutable_buffer]``();
+ `` [''''»''' [link boost_asio.reference.mutable_buffer.mutable_buffer.overload1 more...]]``
+Construct a buffer to represent a given memory range.
-[endsect]
+ ``[link boost_asio.reference.mutable_buffer.mutable_buffer.overload2 mutable_buffer]``(
+ void * data,
+ std::size_t size);
+ `` [''''»''' [link boost_asio.reference.mutable_buffer.mutable_buffer.overload2 more...]]``
-[section:overload2 local::connect_pair (2 of 2 overloads)]
+[section:overload1 mutable_buffer::mutable_buffer (1 of 2 overloads)]
-Create a pair of connected sockets.
+Construct an empty buffer.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``,
- typename ``[link boost_asio.reference.SocketService SocketService1]``,
- typename ``[link boost_asio.reference.SocketService SocketService2]``>
- boost::system::error_code connect_pair(
- basic_socket< Protocol, SocketService1 > & socket1,
- basic_socket< Protocol, SocketService2 > & socket2,
- boost::system::error_code & ec);
+ mutable_buffer();
[endsect]
-[endsect]
-[section:local__datagram_protocol local::datagram_protocol]
+[section:overload2 mutable_buffer::mutable_buffer (2 of 2 overloads)]
-Encapsulates the flags needed for datagram-oriented UNIX sockets.
+Construct a buffer to represent a given memory range.
- class datagram_protocol
+ mutable_buffer(
+ void * data,
+ std::size_t size);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.local__datagram_protocol.endpoint [*endpoint]]]
- [The type of a UNIX domain endpoint. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.local__datagram_protocol.socket [*socket]]]
- [The UNIX domain socket type. ]
-
- ]
+[section:operator_plus_ mutable_buffer::operator+]
-]
+[indexterm2 operator+..mutable_buffer]
+Create a new modifiable buffer that is offset from the start of another.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.local__datagram_protocol.family [*family]]]
- [Obtain an identifier for the protocol family. ]
- ]
-
- [
- [[link boost_asio.reference.local__datagram_protocol.protocol [*protocol]]]
- [Obtain an identifier for the protocol. ]
- ]
-
- [
- [[link boost_asio.reference.local__datagram_protocol.type [*type]]]
- [Obtain an identifier for the type of the protocol. ]
- ]
-
-]
+ mutable_buffer ``[link boost_asio.reference.mutable_buffer.operator_plus_.overload1 operator+]``(
+ const mutable_buffer & b,
+ std::size_t start);
+ `` [''''»''' [link boost_asio.reference.mutable_buffer.operator_plus_.overload1 more...]]``
-The [link boost_asio.reference.local__datagram_protocol `local::datagram_protocol`] class contains flags necessary for datagram-oriented UNIX domain sockets.
+ mutable_buffer ``[link boost_asio.reference.mutable_buffer.operator_plus_.overload2 operator+]``(
+ std::size_t start,
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.mutable_buffer.operator_plus_.overload2 more...]]``
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[section:overload1 mutable_buffer::operator+ (1 of 2 overloads)]
-[*Shared] [*objects:] Safe.
+Create a new modifiable buffer that is offset from the start of another.
+ mutable_buffer operator+(
+ const mutable_buffer & b,
+ std::size_t start);
-[heading Requirements]
-[*Header: ][^boost/asio/local/datagram_protocol.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:endpoint local::datagram_protocol::endpoint]
-[indexterm2 endpoint..local::datagram_protocol]
-The type of a UNIX domain endpoint.
+[section:overload2 mutable_buffer::operator+ (2 of 2 overloads)]
- typedef basic_endpoint< datagram_protocol > endpoint;
+Create a new modifiable buffer that is offset from the start of another.
-[heading Types]
-[table
- [[Name][Description]]
+ mutable_buffer operator+(
+ std::size_t start,
+ const mutable_buffer & b);
- [
- [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
-
- ]
-]
+[endsect]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
- [Default constructor.
+[endsect]
- Construct an endpoint using the specified path name.
+[section:mutable_buffers_1 mutable_buffers_1]
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
- [Get the path associated with the endpoint.
- Set the path associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
- ]
-
-]
+Adapts a single modifiable buffer so that it meets the requirements of the MutableBufferSequence concept.
-[heading Friends]
+
+ class mutable_buffers_1 :
+ public mutable_buffer
+
+
+[heading Types]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
- ]
+
+ [[link boost_asio.reference.mutable_buffers_1.const_iterator [*const_iterator]]]
+ [A random-access iterator type that may be used to read elements. ]
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
]
-
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
- ]
+
+ [[link boost_asio.reference.mutable_buffers_1.value_type [*value_type]]]
+ [The type for each element in the list of buffers. ]
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
+ [[link boost_asio.reference.mutable_buffers_1.begin [*begin]]]
+ [Get a random-access iterator to the first element. ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.mutable_buffers_1.end [*end]]]
+ [Get a random-access iterator for one past the last element. ]
]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
+ [[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1 [*mutable_buffers_1]]]
+ [Construct to represent a given memory range.
+
+ Construct to represent a single modifiable buffer. ]
]
]
@@ -65849,28 +69330,46 @@
[[Name][Description]]
[
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
+ [[link boost_asio.reference.mutable_buffers_1.operator_plus_ [*operator+]]]
+ [Create a new modifiable buffer that is offset from the start of another. ]
]
]
-The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+[heading Requirements]
+[*Header: ][^boost/asio/buffer.hpp]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:begin mutable_buffers_1::begin]
+
+[indexterm2 begin..mutable_buffers_1]
+Get a random-access iterator to the first element.
-[*Shared] [*objects:] Unsafe.
+ const_iterator begin() const;
+
+
+
+[endsect]
+
+
+
+[section:const_iterator mutable_buffers_1::const_iterator]
+
+[indexterm2 const_iterator..mutable_buffers_1]
+A random-access iterator type that may be used to read elements.
+ typedef const mutable_buffer * const_iterator;
+
[heading Requirements]
-[*Header: ][^boost/asio/local/datagram_protocol.hpp]
+[*Header: ][^boost/asio/buffer.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -65879,725 +69378,506 @@
-[section:family local::datagram_protocol::family]
+[section:end mutable_buffers_1::end]
-[indexterm2 family..local::datagram_protocol]
-Obtain an identifier for the protocol family.
+[indexterm2 end..mutable_buffers_1]
+Get a random-access iterator for one past the last element.
- int family() const;
+ const_iterator end() const;
[endsect]
+[section:mutable_buffers_1 mutable_buffers_1::mutable_buffers_1]
-[section:protocol local::datagram_protocol::protocol]
+[indexterm2 mutable_buffers_1..mutable_buffers_1]
+Construct to represent a given memory range.
-[indexterm2 protocol..local::datagram_protocol]
-Obtain an identifier for the protocol.
+ ``[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload1 mutable_buffers_1]``(
+ void * data,
+ std::size_t size);
+ `` [''''»''' [link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload1 more...]]``
- int protocol() const;
+Construct to represent a single modifiable buffer.
-[endsect]
+ explicit ``[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload2 mutable_buffers_1]``(
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload2 more...]]``
+[section:overload1 mutable_buffers_1::mutable_buffers_1 (1 of 2 overloads)]
-[section:socket local::datagram_protocol::socket]
-[indexterm2 socket..local::datagram_protocol]
-The UNIX domain socket type.
+Construct to represent a given memory range.
- typedef basic_datagram_socket< datagram_protocol > socket;
+ mutable_buffers_1(
+ void * data,
+ std::size_t size);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+[section:overload2 mutable_buffers_1::mutable_buffers_1 (2 of 2 overloads)]
- [
- [[link boost_asio.reference.basic_datagram_socket.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
+Construct to represent a single modifiable buffer.
- [
- [[link boost_asio.reference.basic_datagram_socket.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
+ mutable_buffers_1(
+ const mutable_buffer & b);
- [
- [[link boost_asio.reference.basic_datagram_socket.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
+[section:operator_plus_ mutable_buffers_1::operator+]
- [
+[indexterm2 operator+..mutable_buffers_1]
+Create a new modifiable buffer that is offset from the start of another.
- [[link boost_asio.reference.basic_datagram_socket.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
- [
+ mutable_buffer ``[link boost_asio.reference.mutable_buffers_1.operator_plus_.overload1 operator+]``(
+ const mutable_buffer & b,
+ std::size_t start);
+ `` [''''»''' [link boost_asio.reference.mutable_buffers_1.operator_plus_.overload1 more...]]``
- [[link boost_asio.reference.basic_datagram_socket.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
+ mutable_buffer ``[link boost_asio.reference.mutable_buffers_1.operator_plus_.overload2 operator+]``(
+ std::size_t start,
+ const mutable_buffer & b);
+ `` [''''»''' [link boost_asio.reference.mutable_buffers_1.operator_plus_.overload2 more...]]``
- [
- [[link boost_asio.reference.basic_datagram_socket.lowest_layer_type [*lowest_layer_type]]]
- [A basic_socket is always the lowest layer. ]
-
- ]
+[section:overload1 mutable_buffers_1::operator+ (1 of 2 overloads)]
- [
- [[link boost_asio.reference.basic_datagram_socket.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
+['Inherited from mutable_buffer.]
- [
- [[link boost_asio.reference.basic_datagram_socket.native_handle_type [*native_handle_type]]]
- [The native representation of a socket. ]
-
- ]
+Create a new modifiable buffer that is offset from the start of another.
- [
- [[link boost_asio.reference.basic_datagram_socket.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
-
- ]
+ mutable_buffer operator+(
+ const mutable_buffer & b,
+ std::size_t start);
- [
- [[link boost_asio.reference.basic_datagram_socket.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
+[section:overload2 mutable_buffers_1::operator+ (2 of 2 overloads)]
- [
- [[link boost_asio.reference.basic_datagram_socket.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
+['Inherited from mutable_buffer.]
- [
- [[link boost_asio.reference.basic_datagram_socket.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
+Create a new modifiable buffer that is offset from the start of another.
- [
- [[link boost_asio.reference.basic_datagram_socket.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
+ mutable_buffer operator+(
+ std::size_t start,
+ const mutable_buffer & b);
- [
- [[link boost_asio.reference.basic_datagram_socket.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_datagram_socket.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
-
- ]
-]
+[section:value_type mutable_buffers_1::value_type]
+
+[indexterm2 value_type..mutable_buffers_1]
+The type for each element in the list of buffers.
+
+
+ typedef mutable_buffer value_type;
+
[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.basic_datagram_socket.assign [*assign]]]
- [Assign an existing native socket to the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_receive [*async_receive]]]
- [Start an asynchronous receive on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_receive_from [*async_receive_from]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_send [*async_send]]]
- [Start an asynchronous send on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.async_send_to [*async_send_to]]]
- [Start an asynchronous send. ]
+ [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
+ [Construct an empty buffer.
+
+ Construct a buffer to represent a given memory range. ]
]
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.basic_datagram_socket.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
+ [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
+ [Create a new modifiable buffer that is offset from the start of another. ]
]
- [
- [[link boost_asio.reference.basic_datagram_socket.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
+]
+
+The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
+
+
+[heading Accessing Buffer Contents]
- [
- [[link boost_asio.reference.basic_datagram_socket.basic_datagram_socket [*basic_datagram_socket]]]
- [Construct a basic_datagram_socket without opening it.
- Construct and open a basic_datagram_socket.
- Construct a basic_datagram_socket, opening it and binding it to the given local endpoint.
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
- Construct a basic_datagram_socket on an existing native socket.
- Move-construct a basic_datagram_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.bind [*bind]]]
- [Bind the socket to the given local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.close [*close]]]
- [Close the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.connect [*connect]]]
- [Connect the socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.get_option [*get_option]]]
- [Get an option from the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.native_handle [*native_handle]]]
- [Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
+ boost::asio::mutable_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.open [*open]]]
- [Open the socket using the specified protocol. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.operator_eq_ [*operator=]]]
- [Move-assign a basic_datagram_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.receive [*receive]]]
- [Receive some data on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.receive_from [*receive_from]]]
- [Receive a datagram with the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.send [*send]]]
- [Send some data on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.send_to [*send_to]]]
- [Send a datagram to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.set_option [*set_option]]]
- [Set an option on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_datagram_socket.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
-[heading Data Members]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffer.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[endsect]
+
+[section:null_buffers null_buffers]
+
+
+An implementation of both the ConstBufferSequence and MutableBufferSequence concepts to represent a null buffer sequence.
+
+
+ class null_buffers
+
+
+[heading Types]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.basic_datagram_socket.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
-
- [
- [[link boost_asio.reference.basic_datagram_socket.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
+ [[link boost_asio.reference.null_buffers.const_iterator [*const_iterator]]]
+ [A random-access iterator type that may be used to read elements. ]
+
]
[
- [[link boost_asio.reference.basic_datagram_socket.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
- [
- [[link boost_asio.reference.basic_datagram_socket.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
+ [[link boost_asio.reference.null_buffers.value_type [*value_type]]]
+ [The type for each element in the list of buffers. ]
+
]
]
-[heading Protected Data Members]
+[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.basic_datagram_socket.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.null_buffers.begin [*begin]]]
+ [Get a random-access iterator to the first element. ]
]
-
+
[
- [[link boost_asio.reference.basic_datagram_socket.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ [[link boost_asio.reference.null_buffers.end [*end]]]
+ [Get a random-access iterator for one past the last element. ]
]
-
+
]
-The [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class template provides asynchronous and blocking datagram-oriented socket functionality.
-
+[heading Requirements]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[*Header: ][^boost/asio/buffer.hpp]
-[*Shared] [*objects:] Unsafe.
+[*Convenience header: ][^boost/asio.hpp]
+[section:begin null_buffers::begin]
+[indexterm2 begin..null_buffers]
+Get a random-access iterator to the first element.
-[heading Requirements]
-[*Header: ][^boost/asio/local/datagram_protocol.hpp]
+ const_iterator begin() const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:type local::datagram_protocol::type]
+[section:const_iterator null_buffers::const_iterator]
-[indexterm2 type..local::datagram_protocol]
-Obtain an identifier for the type of the protocol.
+[indexterm2 const_iterator..null_buffers]
+A random-access iterator type that may be used to read elements.
- int type() const;
+ typedef const mutable_buffer * const_iterator;
-[endsect]
+[heading Requirements]
+
+[*Header: ][^boost/asio/buffer.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:local__stream_protocol local::stream_protocol]
-Encapsulates the flags needed for stream-oriented UNIX sockets.
+[section:end null_buffers::end]
+[indexterm2 end..null_buffers]
+Get a random-access iterator for one past the last element.
- class stream_protocol
+ const_iterator end() const;
-[heading Types]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.local__stream_protocol.acceptor [*acceptor]]]
- [The UNIX domain acceptor type. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.local__stream_protocol.endpoint [*endpoint]]]
- [The type of a UNIX domain endpoint. ]
-
- ]
- [
+[section:value_type null_buffers::value_type]
- [[link boost_asio.reference.local__stream_protocol.iostream [*iostream]]]
- [The UNIX domain iostream type. ]
-
- ]
+[indexterm2 value_type..null_buffers]
+The type for each element in the list of buffers.
- [
- [[link boost_asio.reference.local__stream_protocol.socket [*socket]]]
- [The UNIX domain socket type. ]
-
- ]
+ typedef mutable_buffer value_type;
-]
[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.local__stream_protocol.family [*family]]]
- [Obtain an identifier for the protocol family. ]
- ]
-
- [
- [[link boost_asio.reference.local__stream_protocol.protocol [*protocol]]]
- [Obtain an identifier for the protocol. ]
+ [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
+ [Construct an empty buffer.
+
+ Construct a buffer to represent a given memory range. ]
]
+]
+
+[heading Related Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.local__stream_protocol.type [*type]]]
- [Obtain an identifier for the type of the protocol. ]
+ [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
+ [Create a new modifiable buffer that is offset from the start of another. ]
]
]
-The [link boost_asio.reference.local__stream_protocol `local::stream_protocol`] class contains flags necessary for stream-oriented UNIX domain sockets.
+The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
-[heading Thread Safety]
+[heading Accessing Buffer Contents]
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Safe.
+
+The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+
+
+
+ boost::asio::mutable_buffer b1 = ...;
+ std::size_t s1 = boost::asio::buffer_size(b1);
+ unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
+The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+
+
[heading Requirements]
-[*Header: ][^boost/asio/local/stream_protocol.hpp]
+[*Header: ][^boost/asio/buffer.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:acceptor local::stream_protocol::acceptor]
+[endsect]
-[indexterm2 acceptor..local::stream_protocol]
-The UNIX domain acceptor type.
- typedef basic_socket_acceptor< stream_protocol > acceptor;
+[endsect]
-[heading Types]
-[table
- [[Name][Description]]
+[section:placeholders__bytes_transferred placeholders::bytes_transferred]
- [
+[indexterm1 placeholders::bytes_transferred]
+An argument placeholder, for use with boost::bind(), that corresponds to the bytes\_transferred argument of a handler for asynchronous functions such as `boost::asio::basic_stream_socket::async_write_some` or `boost::asio::async_write`.
- [[link boost_asio.reference.basic_socket_acceptor.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
- [
+ unspecified bytes_transferred;
- [[link boost_asio.reference.basic_socket_acceptor.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
- [
+[heading Requirements]
- [[link boost_asio.reference.basic_socket_acceptor.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
+[*Header: ][^boost/asio/placeholders.hpp]
- [
+[*Convenience header: ][^boost/asio.hpp]
- [[link boost_asio.reference.basic_socket_acceptor.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_socket_acceptor.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
+[section:placeholders__error placeholders::error]
- [
+[indexterm1 placeholders::error]
+An argument placeholder, for use with boost::bind(), that corresponds to the error argument of a handler for any of the asynchronous functions.
- [[link boost_asio.reference.basic_socket_acceptor.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
- [
+ unspecified error;
- [[link boost_asio.reference.basic_socket_acceptor.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
- [
+[heading Requirements]
- [[link boost_asio.reference.basic_socket_acceptor.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
+[*Header: ][^boost/asio/placeholders.hpp]
- [
+[*Convenience header: ][^boost/asio.hpp]
- [[link boost_asio.reference.basic_socket_acceptor.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_socket_acceptor.native_handle_type [*native_handle_type]]]
- [The native representation of an acceptor. ]
-
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of an acceptor. ]
-
- ]
+[section:placeholders__iterator placeholders::iterator]
- [
+[indexterm1 placeholders::iterator]
+An argument placeholder, for use with boost::bind(), that corresponds to the iterator argument of a handler for asynchronous functions such as boost::asio::basic\_resolver::async\_resolve.
- [[link boost_asio.reference.basic_socket_acceptor.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
- [
+ unspecified iterator;
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/placeholders.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:placeholders__signal_number placeholders::signal_number]
+
+[indexterm1 placeholders::signal_number]
+An argument placeholder, for use with boost::bind(), that corresponds to the signal\_number argument of a handler for asynchronous functions such as `boost::asio::signal_set::async_wait`.
+
+
+ unspecified signal_number;
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/placeholders.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:posix__basic_descriptor posix::basic_descriptor]
+
+
+Provides POSIX descriptor functionality.
- [[link boost_asio.reference.basic_socket_acceptor.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+
+ template<
+ typename ``[link boost_asio.reference.DescriptorService DescriptorService]``>
+ class basic_descriptor :
+ public basic_io_object< DescriptorService >,
+ public posix::descriptor_base
+
+
+[heading Types]
+[table
+ [[Name][Description]]
[
- [[link boost_asio.reference.basic_socket_acceptor.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
+ [[link boost_asio.reference.posix__basic_descriptor.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
+ [[link boost_asio.reference.posix__basic_descriptor.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
+ [[link boost_asio.reference.posix__basic_descriptor.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_descriptor is always the lowest layer. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
+ [[link boost_asio.reference.posix__basic_descriptor.native_handle_type [*native_handle_type]]]
+ [The native representation of a descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
+ [[link boost_asio.reference.posix__basic_descriptor.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.posix__basic_descriptor.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
+ [[link boost_asio.reference.posix__basic_descriptor.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
]
@@ -66608,204 +69888,349 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_socket_acceptor.accept [*accept]]]
- [Accept a new connection.
+ [[link boost_asio.reference.posix__basic_descriptor.assign [*assign]]]
+ [Assign an existing native descriptor to the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.basic_descriptor [*basic_descriptor]]]
+ [Construct a basic_descriptor without opening it.
- Accept a new connection and obtain the endpoint of the peer. ]
+ Construct a basic_descriptor on an existing native descriptor.
+
+ Move-construct a basic_descriptor from another. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.assign [*assign]]]
- [Assigns an existing native acceptor to the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.async_accept [*async_accept]]]
- [Start an asynchronous accept. ]
+ [[link boost_asio.reference.posix__basic_descriptor.close [*close]]]
+ [Close the descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.basic_socket_acceptor [*basic_socket_acceptor]]]
- [Construct an acceptor without opening it.
-
- Construct an open acceptor.
-
- Construct an acceptor opened on the given endpoint.
-
- Construct a basic_socket_acceptor on an existing native acceptor.
-
- Move-construct a basic_socket_acceptor from another. ]
+ [[link boost_asio.reference.posix__basic_descriptor.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.bind [*bind]]]
- [Bind the acceptor to the given local endpoint. ]
+ [[link boost_asio.reference.posix__basic_descriptor.io_control [*io_control]]]
+ [Perform an IO control command on the descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.is_open [*is_open]]]
+ [Determine whether the descriptor is open. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.close [*close]]]
- [Close the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.posix__basic_descriptor.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.get_option [*get_option]]]
- [Get an option from the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.native_handle [*native_handle]]]
+ [Get the native descriptor representation. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.io_control [*io_control]]]
- [Perform an IO control command on the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native descriptor implementation.
+
+ Sets the non-blocking mode of the native descriptor implementation. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.is_open [*is_open]]]
- [Determine whether the acceptor is open. ]
+ [[link boost_asio.reference.posix__basic_descriptor.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the descriptor.
+
+ Sets the non-blocking mode of the descriptor. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.listen [*listen]]]
- [Place the acceptor into the state where it will listen for new connections. ]
+ [[link boost_asio.reference.posix__basic_descriptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_descriptor from another. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the acceptor. ]
+ [[link boost_asio.reference.posix__basic_descriptor.release [*release]]]
+ [Release ownership of the native descriptor implementation. ]
]
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.basic_socket_acceptor.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native acceptor representation. ]
+ [[link boost_asio.reference.posix__basic_descriptor.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.native_handle [*native_handle]]]
- [Get the native acceptor representation. ]
+ [[link boost_asio.reference.posix__basic_descriptor.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
]
[
- [[link boost_asio.reference.basic_socket_acceptor.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native acceptor implementation.
+ [[link boost_asio.reference.posix__basic_descriptor._basic_descriptor [*~basic_descriptor]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] class template provides the ability to wrap a POSIX descriptor.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+[section:assign posix::basic_descriptor::assign]
+
+[indexterm2 assign..posix::basic_descriptor]
+Assign an existing native descriptor to the descriptor.
+
+
+ void ``[link boost_asio.reference.posix__basic_descriptor.assign.overload1 assign]``(
+ const native_handle_type & native_descriptor);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.assign.overload1 more...]]``
+
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.assign.overload2 assign]``(
+ const native_handle_type & native_descriptor,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.assign.overload2 more...]]``
+
+
+[section:overload1 posix::basic_descriptor::assign (1 of 2 overloads)]
+
+
+Assign an existing native descriptor to the descriptor.
+
+
+ void assign(
+ const native_handle_type & native_descriptor);
+
+
+
+[endsect]
+
+
+
+[section:overload2 posix::basic_descriptor::assign (2 of 2 overloads)]
+
+
+Assign an existing native descriptor to the descriptor.
+
+
+ boost::system::error_code assign(
+ const native_handle_type & native_descriptor,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+[endsect]
+
+[section:basic_descriptor posix::basic_descriptor::basic_descriptor]
+
+[indexterm2 basic_descriptor..posix::basic_descriptor]
+Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] without opening it.
+
+
+ explicit ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload1 basic_descriptor]``(
+ boost::asio::io_service & io_service);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload1 more...]]``
+
+
+Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] on an existing native descriptor.
+
+
+ ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload2 basic_descriptor]``(
+ boost::asio::io_service & io_service,
+ const native_handle_type & native_descriptor);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload2 more...]]``
+
+
+Move-construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
+
+
+ ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload3 basic_descriptor]``(
+ basic_descriptor && other);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload3 more...]]``
+
+
+[section:overload1 posix::basic_descriptor::basic_descriptor (1 of 3 overloads)]
+
+
+Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] without opening it.
+
+
+ basic_descriptor(
+ boost::asio::io_service & io_service);
+
+
+This constructor creates a descriptor without opening it.
- Sets the non-blocking mode of the native acceptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the acceptor.
- Sets the non-blocking mode of the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.open [*open]]]
- [Open the acceptor using the specified protocol. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_socket_acceptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_acceptor.set_option [*set_option]]]
- [Set an option on the acceptor. ]
- ]
+[heading Parameters]
+
+
+[variablelist
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor. ]]
+
]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
+
+
+[endsect]
+
+
+
+[section:overload2 posix::basic_descriptor::basic_descriptor (2 of 3 overloads)]
+
+
+Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] on an existing native descriptor.
+
+
+ basic_descriptor(
+ boost::asio::io_service & io_service,
+ const native_handle_type & native_descriptor);
+
+
+This constructor creates a descriptor object to hold an existing native descriptor.
+
+
+[heading Parameters]
+
+
+[variablelist
- [
- [[link boost_asio.reference.basic_socket_acceptor.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor.]]
+
+[[native_descriptor][A native descriptor.]]
+
+]
+
+
+[heading Exceptions]
+
+
+[variablelist
+[[boost::system::system_error][Thrown on failure. ]]
+
]
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_socket_acceptor.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
- [
- [[link boost_asio.reference.basic_socket_acceptor.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
- ]
-]
+[section:overload3 posix::basic_descriptor::basic_descriptor (3 of 3 overloads)]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_socket_acceptor.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
+Move-construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
- [
- [[link boost_asio.reference.basic_socket_acceptor.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-]
+ basic_descriptor(
+ basic_descriptor && other);
-The [link boost_asio.reference.basic_socket_acceptor `basic_socket_acceptor`] class template is used for accepting new socket connections.
+
+This constructor moves a descriptor from one object to another.
-[heading Thread Safety]
+[heading Parameters]
+
+
+[variablelist
-[*Distinct] [*objects:] Safe.
+[[other][The other [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] object from which the move will occur.]]
+
+]
+
+
+[heading Remarks]
+
+Following the move, the moved-from object is in the same state as if constructed using the `basic_descriptor(io_service&) constructor`.
+
+
+
+
+[endsect]
+
+
+[endsect]
-[*Shared] [*objects:] Unsafe.
+
+[section:bytes_readable posix::basic_descriptor::bytes_readable]
+
+
+['Inherited from posix::descriptor_base.]
+
+[indexterm2 bytes_readable..posix::basic_descriptor]
+IO control command to get the amount of data that can be read without blocking.
+
+
+ typedef implementation_defined bytes_readable;
+
+
+
+Implements the FIONREAD IO control command.
[heading Example]
-Opening a socket acceptor with the SO\_REUSEADDR option enabled:
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- 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();
+
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::descriptor_base::bytes_readable command(true);
+ descriptor.io_control(command);
+ std::size_t bytes_readable = command.get();
@@ -66815,7 +70240,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/local/stream_protocol.hpp]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -66823,712 +70248,306 @@
[endsect]
+[section:cancel posix::basic_descriptor::cancel]
-[section:endpoint local::stream_protocol::endpoint]
+[indexterm2 cancel..posix::basic_descriptor]
+Cancel all asynchronous operations associated with the descriptor.
-[indexterm2 endpoint..local::stream_protocol]
-The type of a UNIX domain endpoint.
+ void ``[link boost_asio.reference.posix__basic_descriptor.cancel.overload1 cancel]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.cancel.overload1 more...]]``
- typedef basic_endpoint< stream_protocol > endpoint;
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.cancel.overload2 cancel]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.cancel.overload2 more...]]``
-[heading Types]
-[table
- [[Name][Description]]
+[section:overload1 posix::basic_descriptor::cancel (1 of 2 overloads)]
- [
- [[link boost_asio.reference.local__basic_endpoint.data_type [*data_type]]]
- [The type of the endpoint structure. This type is dependent on the underlying implementation of the socket layer. ]
-
- ]
+Cancel all asynchronous operations associated with the descriptor.
- [
- [[link boost_asio.reference.local__basic_endpoint.protocol_type [*protocol_type]]]
- [The protocol type associated with the endpoint. ]
-
- ]
+ void cancel();
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
+This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
- [
- [[link boost_asio.reference.local__basic_endpoint.basic_endpoint [*basic_endpoint]]]
- [Default constructor.
- Construct an endpoint using the specified path name.
+[heading Exceptions]
+
- Copy constructor. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.capacity [*capacity]]]
- [Get the capacity of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.data [*data]]]
- [Get the underlying endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_eq_ [*operator=]]]
- [Assign from another endpoint. ]
- ]
+[variablelist
- [
- [[link boost_asio.reference.local__basic_endpoint.path [*path]]]
- [Get the path associated with the endpoint.
+[[boost::system::system_error][Thrown on failure. ]]
- Set the path associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.protocol [*protocol]]]
- [The protocol associated with the endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.resize [*resize]]]
- [Set the underlying size of the endpoint in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.size [*size]]]
- [Get the underlying size of the endpoint in the native type. ]
- ]
-
]
-[heading Friends]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_not__eq_ [*operator!=]]]
- [Compare two endpoints for inequality. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_lt_ [*operator<]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__eq_ [*operator<=]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_eq__eq_ [*operator==]]]
- [Compare two endpoints for equality. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_gt_ [*operator>]]]
- [Compare endpoints for ordering. ]
- ]
-
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_gt__eq_ [*operator>=]]]
- [Compare endpoints for ordering. ]
- ]
-
-]
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.local__basic_endpoint.operator_lt__lt_ [*operator<<]]]
- [Output an endpoint as a string. ]
- ]
-
-]
-The [link boost_asio.reference.local__basic_endpoint `local::basic_endpoint`] class template describes an endpoint that may be associated with a particular UNIX socket.
+[endsect]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[section:overload2 posix::basic_descriptor::cancel (2 of 2 overloads)]
+Cancel all asynchronous operations associated with the descriptor.
+ boost::system::error_code cancel(
+ boost::system::error_code & ec);
-[heading Requirements]
-[*Header: ][^boost/asio/local/stream_protocol.hpp]
+This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
-[*Convenience header: ][^boost/asio.hpp]
+[heading Parameters]
+
-[endsect]
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any. ]]
+]
-[section:family local::stream_protocol::family]
-[indexterm2 family..local::stream_protocol]
-Obtain an identifier for the protocol family.
+[endsect]
- int family() const;
+[endsect]
+[section:close posix::basic_descriptor::close]
-[endsect]
+[indexterm2 close..posix::basic_descriptor]
+Close the descriptor.
+ void ``[link boost_asio.reference.posix__basic_descriptor.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.close.overload1 more...]]``
-[section:iostream local::stream_protocol::iostream]
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.close.overload2 close]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.close.overload2 more...]]``
-[indexterm2 iostream..local::stream_protocol]
-The UNIX domain iostream type.
+[section:overload1 posix::basic_descriptor::close (1 of 2 overloads)]
- typedef basic_socket_iostream< stream_protocol > iostream;
+Close the descriptor.
-[heading Types]
-[table
- [[Name][Description]]
- [
+ void close();
- [[link boost_asio.reference.basic_socket_iostream.duration_type [*duration_type]]]
- [The duration type. ]
-
- ]
- [
+This function is used to close the descriptor. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
- [[link boost_asio.reference.basic_socket_iostream.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+[heading Exceptions]
+
- [[link boost_asio.reference.basic_socket_iostream.time_type [*time_type]]]
- [The time type. ]
+[variablelist
- ]
+[[boost::system::system_error][Thrown on failure. Note that, even if the function indicates an error, the underlying descriptor is closed. ]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_socket_iostream.basic_socket_iostream [*basic_socket_iostream]]]
- [Construct a basic_socket_iostream without establishing a connection.
- Establish a connection to an endpoint corresponding to a resolver query. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.close [*close]]]
- [Close the connection. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.connect [*connect]]]
- [Establish a connection to an endpoint corresponding to a resolver query. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.error [*error]]]
- [Get the last error associated with the stream. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.expires_at [*expires_at]]]
- [Get the stream's expiry time as an absolute time.
- Set the stream's expiry time as an absolute time. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.expires_from_now [*expires_from_now]]]
- [Get the timer's expiry time relative to now.
+[endsect]
- Set the stream's expiry time relative to now. ]
- ]
-
- [
- [[link boost_asio.reference.basic_socket_iostream.rdbuf [*rdbuf]]]
- [Return a pointer to the underlying streambuf. ]
- ]
+
+
+[section:overload2 posix::basic_descriptor::close (2 of 2 overloads)]
+
+
+Close the descriptor.
+
+
+ boost::system::error_code close(
+ boost::system::error_code & ec);
+
+
+This function is used to close the descriptor. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
+
+
+[heading Parameters]
+
+
+[variablelist
+[[ec][Set to indicate what error occurred, if any. Note that, even if the function indicates an error, the underlying descriptor is closed. ]]
+
]
-[heading Requirements]
-[*Header: ][^boost/asio/local/stream_protocol.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:get_implementation posix::basic_descriptor::get_implementation]
+[indexterm2 get_implementation..posix::basic_descriptor]
+Get the underlying implementation of the I/O object.
-[section:protocol local::stream_protocol::protocol]
-[indexterm2 protocol..local::stream_protocol]
-Obtain an identifier for the protocol.
+ implementation_type & ``[link boost_asio.reference.posix__basic_descriptor.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_implementation.overload1 more...]]``
+ const implementation_type & ``[link boost_asio.reference.posix__basic_descriptor.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_implementation.overload2 more...]]``
- int protocol() const;
+[section:overload1 posix::basic_descriptor::get_implementation (1 of 2 overloads)]
-[endsect]
+['Inherited from basic_io_object.]
+Get the underlying implementation of the I/O object.
-[section:socket local::stream_protocol::socket]
-[indexterm2 socket..local::stream_protocol]
-The UNIX domain socket type.
+ implementation_type & get_implementation();
- typedef basic_stream_socket< stream_protocol > socket;
+[endsect]
-[heading Types]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_stream_socket.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
+[section:overload2 posix::basic_descriptor::get_implementation (2 of 2 overloads)]
- [
- [[link boost_asio.reference.basic_stream_socket.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+['Inherited from basic_io_object.]
- [
- [[link boost_asio.reference.basic_stream_socket.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
+Get the underlying implementation of the I/O object.
- [
- [[link boost_asio.reference.basic_stream_socket.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
+ const implementation_type & get_implementation() const;
- [
- [[link boost_asio.reference.basic_stream_socket.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_stream_socket.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_stream_socket.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
- [
+[section:get_io_service posix::basic_descriptor::get_io_service]
- [[link boost_asio.reference.basic_stream_socket.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
- [
+['Inherited from basic_io_object.]
- [[link boost_asio.reference.basic_stream_socket.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
+[indexterm2 get_io_service..posix::basic_descriptor]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
- [
- [[link boost_asio.reference.basic_stream_socket.lowest_layer_type [*lowest_layer_type]]]
- [A basic_socket is always the lowest layer. ]
-
- ]
+ boost::asio::io_service & get_io_service();
+
+
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
+
- [
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
- [[link boost_asio.reference.basic_stream_socket.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
- [
- [[link boost_asio.reference.basic_stream_socket.native_handle_type [*native_handle_type]]]
- [The native representation of a socket. ]
-
- ]
- [
+[endsect]
- [[link boost_asio.reference.basic_stream_socket.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a socket. ]
-
- ]
- [
+[section:get_service posix::basic_descriptor::get_service]
- [[link boost_asio.reference.basic_stream_socket.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
+[indexterm2 get_service..posix::basic_descriptor]
+Get the service associated with the I/O object.
- [
- [[link boost_asio.reference.basic_stream_socket.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+ service_type & ``[link boost_asio.reference.posix__basic_descriptor.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_service.overload1 more...]]``
- [
+ const service_type & ``[link boost_asio.reference.posix__basic_descriptor.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_service.overload2 more...]]``
- [[link boost_asio.reference.basic_stream_socket.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
- [
+[section:overload1 posix::basic_descriptor::get_service (1 of 2 overloads)]
- [[link boost_asio.reference.basic_stream_socket.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
- [
+['Inherited from basic_io_object.]
- [[link boost_asio.reference.basic_stream_socket.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
- [
+Get the service associated with the I/O object.
- [[link boost_asio.reference.basic_stream_socket.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
- [
+ service_type & get_service();
- [[link boost_asio.reference.basic_stream_socket.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
- [
- [[link boost_asio.reference.basic_stream_socket.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_stream_socket.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
-
- ]
-]
+[section:overload2 posix::basic_descriptor::get_service (2 of 2 overloads)]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_stream_socket.assign [*assign]]]
- [Assign an existing native socket to the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.async_receive [*async_receive]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.async_send [*async_send]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.basic_stream_socket [*basic_stream_socket]]]
- [Construct a basic_stream_socket without opening it.
+['Inherited from basic_io_object.]
- Construct and open a basic_stream_socket.
- Construct a basic_stream_socket, opening it and binding it to the given local endpoint.
+Get the service associated with the I/O object.
- Construct a basic_stream_socket on an existing native socket.
- Move-construct a basic_stream_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.bind [*bind]]]
- [Bind the socket to the given local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.close [*close]]]
- [Close the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.connect [*connect]]]
- [Connect the socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.get_option [*get_option]]]
- [Get an option from the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.local_endpoint [*local_endpoint]]]
- [Get the local endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
+ const service_type & get_service() const;
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.native_handle [*native_handle]]]
- [Get the native socket representation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.open [*open]]]
- [Open the socket using the specified protocol. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.operator_eq_ [*operator=]]]
- [Move-assign a basic_stream_socket from another. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.read_some [*read_some]]]
- [Read some data from the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.receive [*receive]]]
- [Receive some data on the socket.
+[endsect]
- Receive some data on a connected socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.send [*send]]]
- [Send some data on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.set_option [*set_option]]]
- [Set an option on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.write_some [*write_some]]]
- [Write some data to the socket. ]
- ]
-
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.basic_stream_socket.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_stream_socket.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
-[heading Data Members]
-[table
- [[Name][Description]]
+[section:implementation posix::basic_descriptor::implementation]
- [
- [[link boost_asio.reference.basic_stream_socket.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
- [
- [[link boost_asio.reference.basic_stream_socket.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
+['Inherited from basic_io_object.]
- [
- [[link boost_asio.reference.basic_stream_socket.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
+[indexterm2 implementation..posix::basic_descriptor]
+(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
- [
- [[link boost_asio.reference.basic_stream_socket.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
- [
- [[link boost_asio.reference.basic_stream_socket.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
- ]
+ implementation_type implementation;
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.basic_stream_socket.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
+[endsect]
- [
- [[link boost_asio.reference.basic_stream_socket.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-]
-The [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] class template provides asynchronous and blocking stream-oriented socket functionality.
+[section:implementation_type posix::basic_descriptor::implementation_type]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+['Inherited from basic_io_object.]
-[*Shared] [*objects:] Unsafe.
+[indexterm2 implementation_type..posix::basic_descriptor]
+The underlying implementation type of I/O object.
+ typedef service_type::implementation_type implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/local/stream_protocol.hpp]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -67536,158 +70555,184 @@
[endsect]
+[section:io_control posix::basic_descriptor::io_control]
-[section:type local::stream_protocol::type]
+[indexterm2 io_control..posix::basic_descriptor]
+Perform an IO control command on the descriptor.
-[indexterm2 type..local::stream_protocol]
-Obtain an identifier for the type of the protocol.
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ void ``[link boost_asio.reference.posix__basic_descriptor.io_control.overload1 io_control]``(
+ IoControlCommand & command);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.io_control.overload1 more...]]``
- int type() const;
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.io_control.overload2 io_control]``(
+ IoControlCommand & command,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.io_control.overload2 more...]]``
+[section:overload1 posix::basic_descriptor::io_control (1 of 2 overloads)]
-[endsect]
+Perform an IO control command on the descriptor.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ void io_control(
+ IoControlCommand & command);
-[section:mutable_buffer mutable_buffer]
+This function is used to execute an IO control command on the descriptor.
-Holds a buffer that can be modified.
+[heading Parameters]
+
- class mutable_buffer
+[variablelist
+
+[[command][The IO control command to be performed on the descriptor.]]
+]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
- [Construct an empty buffer.
+[heading Exceptions]
+
- Construct a buffer to represent a given memory range. ]
- ]
+[variablelist
+[[boost::system::system_error][Thrown on failure.]]
+
]
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
- [Create a new modifiable buffer that is offset from the start of another. ]
- ]
+
+[heading Example]
-]
+Getting the number of bytes ready to read:
-The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::posix::stream_descriptor::bytes_readable command;
+ descriptor.io_control(command);
+ std::size_t bytes_readable = command.get();
-[heading Accessing Buffer Contents]
-
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
- boost::asio::mutable_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
+[endsect]
+[section:overload2 posix::basic_descriptor::io_control (2 of 2 overloads)]
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
-[heading Requirements]
+Perform an IO control command on the descriptor.
-[*Header: ][^boost/asio/buffer.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ IoControlCommand & command,
+ boost::system::error_code & ec);
-[section:mutable_buffer mutable_buffer::mutable_buffer]
-[indexterm2 mutable_buffer..mutable_buffer]
-Construct an empty buffer.
+This function is used to execute an IO control command on the descriptor.
- ``[link boost_asio.reference.mutable_buffer.mutable_buffer.overload1 mutable_buffer]``();
- `` [''''»''' [link boost_asio.reference.mutable_buffer.mutable_buffer.overload1 more...]]``
+[heading Parameters]
+
+[variablelist
+
+[[command][The IO control command to be performed on the descriptor.]]
-Construct a buffer to represent a given memory range.
+[[ec][Set to indicate what error occurred, if any.]]
+]
- ``[link boost_asio.reference.mutable_buffer.mutable_buffer.overload2 mutable_buffer]``(
- void * data,
- std::size_t size);
- `` [''''»''' [link boost_asio.reference.mutable_buffer.mutable_buffer.overload2 more...]]``
-[section:overload1 mutable_buffer::mutable_buffer (1 of 2 overloads)]
+[heading Example]
+
+Getting the number of bytes ready to read:
+
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::posix::stream_descriptor::bytes_readable command;
+ boost::system::error_code ec;
+ descriptor.io_control(command, ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ std::size_t bytes_readable = command.get();
-Construct an empty buffer.
- mutable_buffer();
[endsect]
+[endsect]
-[section:overload2 mutable_buffer::mutable_buffer (2 of 2 overloads)]
+[section:is_open posix::basic_descriptor::is_open]
-Construct a buffer to represent a given memory range.
+[indexterm2 is_open..posix::basic_descriptor]
+Determine whether the descriptor is open.
- mutable_buffer(
- void * data,
- std::size_t size);
+ bool is_open() const;
[endsect]
-[endsect]
+[section:lowest_layer posix::basic_descriptor::lowest_layer]
-[section:operator_plus_ mutable_buffer::operator+]
+[indexterm2 lowest_layer..posix::basic_descriptor]
+Get a reference to the lowest layer.
-[indexterm2 operator+..mutable_buffer]
-Create a new modifiable buffer that is offset from the start of another.
+ lowest_layer_type & ``[link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload1 more...]]``
- mutable_buffer ``[link boost_asio.reference.mutable_buffer.operator_plus_.overload1 operator+]``(
- const mutable_buffer & b,
- std::size_t start);
- `` [''''»''' [link boost_asio.reference.mutable_buffer.operator_plus_.overload1 more...]]``
- mutable_buffer ``[link boost_asio.reference.mutable_buffer.operator_plus_.overload2 operator+]``(
- std::size_t start,
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.mutable_buffer.operator_plus_.overload2 more...]]``
+Get a const reference to the lowest layer.
-[section:overload1 mutable_buffer::operator+ (1 of 2 overloads)]
+ const lowest_layer_type & ``[link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload2 more...]]``
-Create a new modifiable buffer that is offset from the start of another.
+[section:overload1 posix::basic_descriptor::lowest_layer (1 of 2 overloads)]
- mutable_buffer operator+(
- const mutable_buffer & b,
- std::size_t start);
+Get a reference to the lowest layer.
+
+
+ lowest_layer_type & lowest_layer();
+
+
+This function returns a reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] cannot contain any further layers, it simply returns a reference to itself.
+
+
+[heading Return Value]
+
+A reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
+
@@ -67695,19 +70740,23 @@
-[section:overload2 mutable_buffer::operator+ (2 of 2 overloads)]
+[section:overload2 posix::basic_descriptor::lowest_layer (2 of 2 overloads)]
-Create a new modifiable buffer that is offset from the start of another.
+Get a const reference to the lowest layer.
- mutable_buffer operator+(
- std::size_t start,
- const mutable_buffer & b);
+ const lowest_layer_type & lowest_layer() const;
+This function returns a const reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] cannot contain any further layers, it simply returns a reference to itself.
+
+
+[heading Return Value]
+
+A const reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
+
-[endsect]
[endsect]
@@ -67715,14 +70764,14 @@
[endsect]
-[section:mutable_buffers_1 mutable_buffers_1]
+[section:lowest_layer_type posix::basic_descriptor::lowest_layer_type]
-Adapts a single modifiable buffer so that it meets the requirements of the MutableBufferSequence concept.
+[indexterm2 lowest_layer_type..posix::basic_descriptor]
+A [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] is always the lowest layer.
- class mutable_buffers_1 :
- public mutable_buffer
+ typedef basic_descriptor< DescriptorService > lowest_layer_type;
[heading Types]
@@ -67731,15 +70780,50 @@
[
- [[link boost_asio.reference.mutable_buffers_1.const_iterator [*const_iterator]]]
- [A random-access iterator type that may be used to read elements. ]
+ [[link boost_asio.reference.posix__basic_descriptor.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
]
[
- [[link boost_asio.reference.mutable_buffers_1.value_type [*value_type]]]
- [The type for each element in the list of buffers. ]
+ [[link boost_asio.reference.posix__basic_descriptor.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.posix__basic_descriptor.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_descriptor is always the lowest layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.posix__basic_descriptor.native_handle_type [*native_handle_type]]]
+ [The native representation of a descriptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.posix__basic_descriptor.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a descriptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.posix__basic_descriptor.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.posix__basic_descriptor.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
]
@@ -67750,256 +70834,336 @@
[[Name][Description]]
[
- [[link boost_asio.reference.mutable_buffers_1.begin [*begin]]]
- [Get a random-access iterator to the first element. ]
+ [[link boost_asio.reference.posix__basic_descriptor.assign [*assign]]]
+ [Assign an existing native descriptor to the descriptor. ]
]
[
- [[link boost_asio.reference.mutable_buffers_1.end [*end]]]
- [Get a random-access iterator for one past the last element. ]
+ [[link boost_asio.reference.posix__basic_descriptor.basic_descriptor [*basic_descriptor]]]
+ [Construct a basic_descriptor without opening it.
+
+ Construct a basic_descriptor on an existing native descriptor.
+
+ Move-construct a basic_descriptor from another. ]
]
[
- [[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1 [*mutable_buffers_1]]]
- [Construct to represent a given memory range.
+ [[link boost_asio.reference.posix__basic_descriptor.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.close [*close]]]
+ [Close the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.io_control [*io_control]]]
+ [Perform an IO control command on the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.is_open [*is_open]]]
+ [Determine whether the descriptor is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
- Construct to represent a single modifiable buffer. ]
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.native_handle [*native_handle]]]
+ [Get the native descriptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native descriptor implementation.
+
+ Sets the non-blocking mode of the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the descriptor.
+
+ Sets the non-blocking mode of the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_descriptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.release [*release]]]
+ [Release ownership of the native descriptor implementation. ]
]
]
-[heading Related Functions]
+[heading Protected Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.mutable_buffers_1.operator_plus_ [*operator+]]]
- [Create a new modifiable buffer that is offset from the start of another. ]
+ [[link boost_asio.reference.posix__basic_descriptor.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_descriptor._basic_descriptor [*~basic_descriptor]]]
+ [Protected destructor to prevent deletion through this type. ]
]
]
-[heading Requirements]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
-[*Header: ][^boost/asio/buffer.hpp]
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-[*Convenience header: ][^boost/asio.hpp]
+ [
+ [[link boost_asio.reference.posix__basic_descriptor.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
-[section:begin mutable_buffers_1::begin]
+The [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] class template provides the ability to wrap a POSIX descriptor.
-[indexterm2 begin..mutable_buffers_1]
-Get a random-access iterator to the first element.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
- const_iterator begin() const;
+[*Shared] [*objects:] Unsafe.
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
-[section:const_iterator mutable_buffers_1::const_iterator]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 const_iterator..mutable_buffers_1]
-A random-access iterator type that may be used to read elements.
+
+[endsect]
- typedef const mutable_buffer * const_iterator;
+[section:native posix::basic_descriptor::native]
+[indexterm2 native..posix::basic_descriptor]
+(Deprecated: Use `native_handle()`.) Get the native descriptor representation.
-[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+ native_type native();
-[*Convenience header: ][^boost/asio.hpp]
+
+This function may be used to obtain the underlying representation of the descriptor. This is intended to allow access to native descriptor functionality that is not otherwise provided.
[endsect]
-[section:end mutable_buffers_1::end]
+[section:native_handle posix::basic_descriptor::native_handle]
-[indexterm2 end..mutable_buffers_1]
-Get a random-access iterator for one past the last element.
+[indexterm2 native_handle..posix::basic_descriptor]
+Get the native descriptor representation.
- const_iterator end() const;
+ native_handle_type native_handle();
+
+This function may be used to obtain the underlying representation of the descriptor. This is intended to allow access to native descriptor functionality that is not otherwise provided.
[endsect]
-[section:mutable_buffers_1 mutable_buffers_1::mutable_buffers_1]
-[indexterm2 mutable_buffers_1..mutable_buffers_1]
-Construct to represent a given memory range.
+[section:native_handle_type posix::basic_descriptor::native_handle_type]
+[indexterm2 native_handle_type..posix::basic_descriptor]
+The native representation of a descriptor.
- ``[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload1 mutable_buffers_1]``(
- void * data,
- std::size_t size);
- `` [''''»''' [link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload1 more...]]``
+ typedef DescriptorService::native_handle_type native_handle_type;
-Construct to represent a single modifiable buffer.
- explicit ``[link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload2 mutable_buffers_1]``(
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.mutable_buffers_1.mutable_buffers_1.overload2 more...]]``
+[heading Requirements]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
-[section:overload1 mutable_buffers_1::mutable_buffers_1 (1 of 2 overloads)]
+[*Convenience header: ][^boost/asio.hpp]
-Construct to represent a given memory range.
+[endsect]
- mutable_buffers_1(
- void * data,
- std::size_t size);
+[section:native_non_blocking posix::basic_descriptor::native_non_blocking]
+[indexterm2 native_non_blocking..posix::basic_descriptor]
+Gets the non-blocking mode of the native descriptor implementation.
-[endsect]
+ bool ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1 native_non_blocking]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1 more...]]``
+Sets the non-blocking mode of the native descriptor implementation.
-[section:overload2 mutable_buffers_1::mutable_buffers_1 (2 of 2 overloads)]
+ void ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2 native_non_blocking]``(
+ bool mode);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2 more...]]``
-Construct to represent a single modifiable buffer.
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3 native_non_blocking]``(
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3 more...]]``
- mutable_buffers_1(
- const mutable_buffer & b);
+[section:overload1 posix::basic_descriptor::native_non_blocking (1 of 3 overloads)]
+Gets the non-blocking mode of the native descriptor implementation.
-[endsect]
+ bool native_non_blocking() const;
-[endsect]
-[section:operator_plus_ mutable_buffers_1::operator+]
+This function is used to retrieve the non-blocking mode of the underlying native descriptor. This mode has no effect on the behaviour of the descriptor object's synchronous operations.
-[indexterm2 operator+..mutable_buffers_1]
-Create a new modifiable buffer that is offset from the start of another.
+[heading Return Value]
+
+`true` if the underlying descriptor is in non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).
- mutable_buffer ``[link boost_asio.reference.mutable_buffers_1.operator_plus_.overload1 operator+]``(
- const mutable_buffer & b,
- std::size_t start);
- `` [''''»''' [link boost_asio.reference.mutable_buffers_1.operator_plus_.overload1 more...]]``
- mutable_buffer ``[link boost_asio.reference.mutable_buffers_1.operator_plus_.overload2 operator+]``(
- std::size_t start,
- const mutable_buffer & b);
- `` [''''»''' [link boost_asio.reference.mutable_buffers_1.operator_plus_.overload2 more...]]``
+[heading Remarks]
+
+The current non-blocking mode is cached by the descriptor object. Consequently, the return value may be incorrect if the non-blocking mode was set directly on the native descriptor.
-[section:overload1 mutable_buffers_1::operator+ (1 of 2 overloads)]
-['Inherited from mutable_buffer.]
+[endsect]
-Create a new modifiable buffer that is offset from the start of another.
+[section:overload2 posix::basic_descriptor::native_non_blocking (2 of 3 overloads)]
- mutable_buffer operator+(
- const mutable_buffer & b,
- std::size_t start);
+Sets the non-blocking mode of the native descriptor implementation.
-[endsect]
+ void native_non_blocking(
+ bool mode);
+This function is used to modify the non-blocking mode of the underlying native descriptor. It has no effect on the behaviour of the descriptor object's synchronous operations.
-[section:overload2 mutable_buffers_1::operator+ (2 of 2 overloads)]
+[heading Parameters]
+
-['Inherited from mutable_buffer.]
+[variablelist
+
+[[mode][If `true`, the underlying descriptor is put into non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).]]
+]
-Create a new modifiable buffer that is offset from the start of another.
+[heading Exceptions]
+
- mutable_buffer operator+(
- std::size_t start,
- const mutable_buffer & b);
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. If the `mode` is `false`, but the current value of `non_blocking()` is `true`, this function fails with `boost::asio::error::invalid_argument`, as the combination does not make sense. ]]
+]
-[endsect]
[endsect]
-[section:value_type mutable_buffers_1::value_type]
-[indexterm2 value_type..mutable_buffers_1]
-The type for each element in the list of buffers.
+[section:overload3 posix::basic_descriptor::native_non_blocking (3 of 3 overloads)]
- typedef mutable_buffer value_type;
+Sets the non-blocking mode of the native descriptor implementation.
-[heading Member Functions]
-[table
- [[Name][Description]]
+ boost::system::error_code native_non_blocking(
+ bool mode,
+ boost::system::error_code & ec);
- [
- [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
- [Construct an empty buffer.
- Construct a buffer to represent a given memory range. ]
- ]
-
-]
+This function is used to modify the non-blocking mode of the underlying native descriptor. It has no effect on the behaviour of the descriptor object's synchronous operations.
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
- [Create a new modifiable buffer that is offset from the start of another. ]
- ]
+[heading Parameters]
+
+
+[variablelist
+[[mode][If `true`, the underlying descriptor is put into non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).]]
+
+[[ec][Set to indicate what error occurred, if any. If the `mode` is `false`, but the current value of `non_blocking()` is `true`, this function fails with `boost::asio::error::invalid_argument`, as the combination does not make sense. ]]
+
]
-The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
-[heading Accessing Buffer Contents]
-
+[endsect]
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+[endsect]
- boost::asio::mutable_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
+[section:native_type posix::basic_descriptor::native_type]
+[indexterm2 native_type..posix::basic_descriptor]
+(Deprecated: Use native\_handle\_type.) The native representation of a descriptor.
+ typedef DescriptorService::native_handle_type native_type;
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -68007,230 +71171,268 @@
[endsect]
+[section:non_blocking posix::basic_descriptor::non_blocking]
+
+[indexterm2 non_blocking..posix::basic_descriptor]
+Gets the non-blocking mode of the descriptor.
+
+
+ bool ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload1 non_blocking]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload1 more...]]``
+
+
+Sets the non-blocking mode of the descriptor.
+
+
+ void ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload2 non_blocking]``(
+ bool mode);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload2 more...]]``
+
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload3 non_blocking]``(
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload3 more...]]``
+
+
+[section:overload1 posix::basic_descriptor::non_blocking (1 of 3 overloads)]
+
+
+Gets the non-blocking mode of the descriptor.
+
+
+ bool non_blocking() const;
+
+
+
+[heading Return Value]
+
+`true` if the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.
+
+
+[heading Remarks]
+
+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`.
+
+
+
[endsect]
-[section:null_buffers null_buffers]
-An implementation of both the ConstBufferSequence and MutableBufferSequence concepts to represent a null buffer sequence.
+[section:overload2 posix::basic_descriptor::non_blocking (2 of 3 overloads)]
- class null_buffers
+Sets the non-blocking mode of the descriptor.
-[heading Types]
-[table
- [[Name][Description]]
+ void non_blocking(
+ bool mode);
- [
- [[link boost_asio.reference.null_buffers.const_iterator [*const_iterator]]]
- [A random-access iterator type that may be used to read elements. ]
-
- ]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.null_buffers.value_type [*value_type]]]
- [The type for each element in the list of buffers. ]
+[variablelist
- ]
+[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.null_buffers.begin [*begin]]]
- [Get a random-access iterator to the first element. ]
- ]
-
- [
- [[link boost_asio.reference.null_buffers.end [*end]]]
- [Get a random-access iterator for one past the last element. ]
- ]
+[heading Exceptions]
+
+
+[variablelist
+[[boost::system::system_error][Thrown on failure.]]
+
]
-[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[heading Remarks]
+
+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`.
-[*Convenience header: ][^boost/asio.hpp]
-[section:begin null_buffers::begin]
-[indexterm2 begin..null_buffers]
-Get a random-access iterator to the first element.
+[endsect]
- const_iterator begin() const;
+[section:overload3 posix::basic_descriptor::non_blocking (3 of 3 overloads)]
-[endsect]
+Sets the non-blocking mode of the descriptor.
+ boost::system::error_code non_blocking(
+ bool mode,
+ boost::system::error_code & ec);
-[section:const_iterator null_buffers::const_iterator]
-[indexterm2 const_iterator..null_buffers]
-A random-access iterator type that may be used to read elements.
+[heading Parameters]
+
- typedef const mutable_buffer * const_iterator;
+[variablelist
+
+[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[heading Requirements]
-[*Header: ][^boost/asio/buffer.hpp]
+[heading Remarks]
+
+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`.
+
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[endsect]
-[section:end null_buffers::end]
-[indexterm2 end..null_buffers]
-Get a random-access iterator for one past the last element.
+[section:non_blocking_io posix::basic_descriptor::non_blocking_io]
- const_iterator end() const;
+['Inherited from posix::descriptor_base.]
+[indexterm2 non_blocking_io..posix::basic_descriptor]
+(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
-[endsect]
+ typedef implementation_defined non_blocking_io;
-[section:value_type null_buffers::value_type]
+Implements the FIONBIO IO control command.
-[indexterm2 value_type..null_buffers]
-The type for each element in the list of buffers.
+[heading Example]
+
- typedef mutable_buffer value_type;
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::descriptor_base::non_blocking_io command(true);
+ descriptor.io_control(command);
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.mutable_buffer.mutable_buffer [*mutable_buffer]]]
- [Construct an empty buffer.
- Construct a buffer to represent a given memory range. ]
- ]
-
-]
-[heading Related Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.mutable_buffer.operator_plus_ [*operator+]]]
- [Create a new modifiable buffer that is offset from the start of another. ]
- ]
-
-]
-The [link boost_asio.reference.mutable_buffer `mutable_buffer`] class provides a safe representation of a buffer that can be modified. It does not own the underlying data, and so is cheap to copy or assign.
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
-[heading Accessing Buffer Contents]
-
+[endsect]
-The contents of a buffer may be accessed using the [link boost_asio.reference.buffer_size `buffer_size`] and [link boost_asio.reference.buffer_cast `buffer_cast`] functions:
+[section:operator_eq_ posix::basic_descriptor::operator=]
+[indexterm2 operator=..posix::basic_descriptor]
+Move-assign a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
- boost::asio::mutable_buffer b1 = ...;
- std::size_t s1 = boost::asio::buffer_size(b1);
- unsigned char* p1 = boost::asio::buffer_cast<unsigned char*>(b1);
+ basic_descriptor & operator=(
+ basic_descriptor && other);
+This assignment operator moves a descriptor from one object to another.
-The `boost::asio::buffer_cast` function permits violations of type safety, so uses of it in application code should be carefully considered.
+[heading Parameters]
+
-[heading Requirements]
+[variablelist
+
+[[other][The other [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] object from which the move will occur.]]
-[*Header: ][^boost/asio/buffer.hpp]
+]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Remarks]
+
+Following the move, the moved-from object is in the same state as if constructed using the `basic_descriptor(io_service&) constructor`.
-[endsect]
[endsect]
-[section:placeholders__bytes_transferred placeholders::bytes_transferred]
-[indexterm1 placeholders::bytes_transferred]
-An argument placeholder, for use with boost::bind(), that corresponds to the bytes\_transferred argument of a handler for asynchronous functions such as `boost::asio::basic_stream_socket::async_write_some` or `boost::asio::async_write`.
+[section:release posix::basic_descriptor::release]
+[indexterm2 release..posix::basic_descriptor]
+Release ownership of the native descriptor implementation.
- unspecified bytes_transferred;
+ native_handle_type release();
-[heading Requirements]
-[*Header: ][^boost/asio/placeholders.hpp]
+This function may be used to obtain the underlying representation of the descriptor. After calling this function, `is_open()` returns false. The caller is responsible for closing the descriptor.
-[*Convenience header: ][^boost/asio.hpp]
+All outstanding asynchronous read or write operations will finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
[endsect]
-[section:placeholders__error placeholders::error]
+[section:service posix::basic_descriptor::service]
-[indexterm1 placeholders::error]
-An argument placeholder, for use with boost::bind(), that corresponds to the error argument of a handler for any of the asynchronous functions.
+['Inherited from basic_io_object.]
- unspecified error;
+[indexterm2 service..posix::basic_descriptor]
+(Deprecated: Use `get_service()`.) The service associated with the I/O object.
-[heading Requirements]
+ service_type & service;
+
+
+
+[heading Remarks]
+
+Available only for services that do not support movability.
-[*Header: ][^boost/asio/placeholders.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:placeholders__iterator placeholders::iterator]
+[section:service_type posix::basic_descriptor::service_type]
-[indexterm1 placeholders::iterator]
-An argument placeholder, for use with boost::bind(), that corresponds to the iterator argument of a handler for asynchronous functions such as boost::asio::basic\_resolver::async\_resolve.
+['Inherited from basic_io_object.]
+
+[indexterm2 service_type..posix::basic_descriptor]
+The type of the service that will be used to provide I/O operations.
+
+
+ typedef DescriptorService service_type;
- unspecified iterator;
[heading Requirements]
-[*Header: ][^boost/asio/placeholders.hpp]
+[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -68239,36 +71441,32 @@
-[section:placeholders__signal_number placeholders::signal_number]
+[section:_basic_descriptor posix::basic_descriptor::~basic_descriptor]
-[indexterm1 placeholders::signal_number]
-An argument placeholder, for use with boost::bind(), that corresponds to the signal\_number argument of a handler for asynchronous functions such as `boost::asio::signal_set::async_wait`.
+[indexterm2 ~basic_descriptor..posix::basic_descriptor]
+Protected destructor to prevent deletion through this type.
- unspecified signal_number;
+ ~basic_descriptor();
-[heading Requirements]
-[*Header: ][^boost/asio/placeholders.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:posix__basic_descriptor posix::basic_descriptor]
+[section:posix__basic_stream_descriptor posix::basic_stream_descriptor]
-Provides POSIX descriptor functionality.
+Provides stream-oriented descriptor functionality.
template<
- typename ``[link boost_asio.reference.DescriptorService DescriptorService]``>
- class basic_descriptor :
- public basic_io_object< DescriptorService >,
- public posix::descriptor_base
+ typename ``[link boost_asio.reference.StreamDescriptorService StreamDescriptorService]`` = stream_descriptor_service>
+ class basic_stream_descriptor :
+ public posix::basic_descriptor< StreamDescriptorService >
[heading Types]
@@ -68277,49 +71475,49 @@
[
- [[link boost_asio.reference.posix__basic_descriptor.bytes_readable [*bytes_readable]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.bytes_readable [*bytes_readable]]]
[IO control command to get the amount of data that can be read without blocking. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.implementation_type [*implementation_type]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.implementation_type [*implementation_type]]]
[The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.lowest_layer_type [*lowest_layer_type]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type [*lowest_layer_type]]]
[A basic_descriptor is always the lowest layer. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_handle_type [*native_handle_type]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle_type [*native_handle_type]]]
[The native representation of a descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_type [*native_type]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_type [*native_type]]]
[(Deprecated: Use native_handle_type.) The native representation of a descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.non_blocking_io [*non_blocking_io]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io [*non_blocking_io]]]
[(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.service_type [*service_type]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.service_type [*service_type]]]
[The type of the service that will be used to provide I/O operations. ]
]
@@ -68331,85 +71529,105 @@
[[Name][Description]]
[
- [[link boost_asio.reference.posix__basic_descriptor.assign [*assign]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.assign [*assign]]]
[Assign an existing native descriptor to the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.basic_descriptor [*basic_descriptor]]]
- [Construct a basic_descriptor without opening it.
+ [[link boost_asio.reference.posix__basic_stream_descriptor.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor [*basic_stream_descriptor]]]
+ [Construct a basic_stream_descriptor without opening it.
- Construct a basic_descriptor on an existing native descriptor.
+ Construct a basic_stream_descriptor on an existing native descriptor.
- Move-construct a basic_descriptor from another. ]
+ Move-construct a basic_stream_descriptor from another. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.cancel [*cancel]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.cancel [*cancel]]]
[Cancel all asynchronous operations associated with the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.close [*close]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.close [*close]]]
[Close the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.get_io_service [*get_io_service]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.get_io_service [*get_io_service]]]
[Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.io_control [*io_control]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.io_control [*io_control]]]
[Perform an IO control command on the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.is_open [*is_open]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.is_open [*is_open]]]
[Determine whether the descriptor is open. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.lowest_layer [*lowest_layer]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer [*lowest_layer]]]
[Get a reference to the lowest layer.
Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native [*native]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native [*native]]]
[(Deprecated: Use native_handle().) Get the native descriptor representation. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_handle [*native_handle]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle [*native_handle]]]
[Get the native descriptor representation. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_non_blocking [*native_non_blocking]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking [*native_non_blocking]]]
[Gets the non-blocking mode of the native descriptor implementation.
Sets the non-blocking mode of the native descriptor implementation. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.non_blocking [*non_blocking]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking [*non_blocking]]]
[Gets the non-blocking mode of the descriptor.
Sets the non-blocking mode of the descriptor. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_descriptor from another. ]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_stream_descriptor from another. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.release [*release]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.read_some [*read_some]]]
+ [Read some data from the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.release [*release]]]
[Release ownership of the native descriptor implementation. ]
]
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.write_some [*write_some]]]
+ [Write some data to the descriptor. ]
+ ]
+
]
[heading Protected Member Functions]
@@ -68417,20 +71635,15 @@
[[Name][Description]]
[
- [[link boost_asio.reference.posix__basic_descriptor.get_implementation [*get_implementation]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation [*get_implementation]]]
[Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.get_service [*get_service]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.get_service [*get_service]]]
[Get the service associated with the I/O object. ]
]
- [
- [[link boost_asio.reference.posix__basic_descriptor._basic_descriptor [*~basic_descriptor]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
]
[heading Protected Data Members]
@@ -68438,51 +71651,55 @@
[[Name][Description]]
[
- [[link boost_asio.reference.posix__basic_descriptor.implementation [*implementation]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.implementation [*implementation]]]
[(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.service [*service]]]
+ [[link boost_asio.reference.posix__basic_stream_descriptor.service [*service]]]
[(Deprecated: Use get_service().) The service associated with the I/O object. ]
]
]
-The [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] class template provides the ability to wrap a POSIX descriptor.
+The [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template provides asynchronous and blocking stream-oriented descriptor functionality.
[heading Thread Safety]
[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Unsafe.
+[*Shared] [*objects:] Unsafe.
+
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:assign posix::basic_descriptor::assign]
+[section:assign posix::basic_stream_descriptor::assign]
-[indexterm2 assign..posix::basic_descriptor]
+[indexterm2 assign..posix::basic_stream_descriptor]
Assign an existing native descriptor to the descriptor.
- void ``[link boost_asio.reference.posix__basic_descriptor.assign.overload1 assign]``(
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.assign.overload1 assign]``(
const native_handle_type & native_descriptor);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.assign.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.assign.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.assign.overload2 assign]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.assign.overload2 assign]``(
const native_handle_type & native_descriptor,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.assign.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.assign.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::assign (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::assign (1 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Assign an existing native descriptor to the descriptor.
@@ -68497,7 +71714,10 @@
-[section:overload2 posix::basic_descriptor::assign (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::assign (2 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Assign an existing native descriptor to the descriptor.
@@ -68514,45 +71734,159 @@
[endsect]
-[section:basic_descriptor posix::basic_descriptor::basic_descriptor]
-[indexterm2 basic_descriptor..posix::basic_descriptor]
-Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] without opening it.
+[section:async_read_some posix::basic_stream_descriptor::async_read_some]
+[indexterm2 async_read_some..posix::basic_stream_descriptor]
+Start an asynchronous read.
- explicit ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload1 basic_descriptor]``(
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
+
+
+This function is used to asynchronously read data from the stream descriptor. The function call always returns immediately.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[buffers][One or more buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
+
+[[handler][The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ std::size_t bytes_transferred // Number of bytes read.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
+
+]
+
+
+[heading Remarks]
+
+The read operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.async_read `async_read`] function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.
+
+
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+
+ descriptor.async_read_some(boost::asio::buffer(data, size), handler);
+
+
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+
+
+
+
+[endsect]
+
+
+
+[section:async_write_some posix::basic_stream_descriptor::async_write_some]
+
+[indexterm2 async_write_some..posix::basic_stream_descriptor]
+Start an asynchronous write.
+
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
+
+
+This function is used to asynchronously write data to the stream descriptor. The function call always returns immediately.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[buffers][One or more data buffers to be written to the descriptor. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
+
+[[handler][The handler to be called when the write operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ std::size_t bytes_transferred // Number of bytes written.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
+
+]
+
+
+[heading Remarks]
+
+The write operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.async_write `async_write`] function if you need to ensure that all data is written before the asynchronous operation completes.
+
+
+[heading Example]
+
+To write a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+
+ descriptor.async_write_some(boost::asio::buffer(data, size), handler);
+
+
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+
+
+
+
+[endsect]
+
+
+[section:basic_stream_descriptor posix::basic_stream_descriptor::basic_stream_descriptor]
+
+[indexterm2 basic_stream_descriptor..posix::basic_stream_descriptor]
+Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] without opening it.
+
+
+ explicit ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1 basic_stream_descriptor]``(
boost::asio::io_service & io_service);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1 more...]]``
-Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] on an existing native descriptor.
+Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] on an existing native descriptor.
- ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload2 basic_descriptor]``(
+ ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2 basic_stream_descriptor]``(
boost::asio::io_service & io_service,
const native_handle_type & native_descriptor);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2 more...]]``
-Move-construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
+Move-construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
- ``[link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload3 basic_descriptor]``(
- basic_descriptor && other);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.basic_descriptor.overload3 more...]]``
+ ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3 basic_stream_descriptor]``(
+ basic_stream_descriptor && other);
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3 more...]]``
-[section:overload1 posix::basic_descriptor::basic_descriptor (1 of 3 overloads)]
+[section:overload1 posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)]
-Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] without opening it.
+Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] without opening it.
- basic_descriptor(
+ basic_stream_descriptor(
boost::asio::io_service & io_service);
-This constructor creates a descriptor without opening it.
+This constructor creates a stream descriptor without opening it. The descriptor needs to be opened and then connected or accepted before data can be sent or received on it.
[heading Parameters]
@@ -68560,7 +71894,7 @@
[variablelist
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor. ]]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the stream descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor. ]]
]
@@ -68571,18 +71905,18 @@
-[section:overload2 posix::basic_descriptor::basic_descriptor (2 of 3 overloads)]
+[section:overload2 posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)]
-Construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] on an existing native descriptor.
+Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] on an existing native descriptor.
- basic_descriptor(
+ basic_stream_descriptor(
boost::asio::io_service & io_service,
const native_handle_type & native_descriptor);
-This constructor creates a descriptor object to hold an existing native descriptor.
+This constructor creates a stream descriptor object to hold an existing native descriptor.
[heading Parameters]
@@ -68590,9 +71924,9 @@
[variablelist
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor.]]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the stream descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor.]]
-[[native_descriptor][A native descriptor.]]
+[[native_descriptor][The new underlying descriptor implementation.]]
]
@@ -68613,17 +71947,17 @@
-[section:overload3 posix::basic_descriptor::basic_descriptor (3 of 3 overloads)]
+[section:overload3 posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)]
-Move-construct a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
+Move-construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
- basic_descriptor(
- basic_descriptor && other);
+ basic_stream_descriptor(
+ basic_stream_descriptor && other);
-This constructor moves a descriptor from one object to another.
+This constructor moves a stream descriptor from one object to another.
[heading Parameters]
@@ -68631,14 +71965,14 @@
[variablelist
-[[other][The other [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] object from which the move will occur.]]
+[[other][The other [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] object from which the move will occur.]]
]
[heading Remarks]
-Following the move, the moved-from object is in the same state as if constructed using the `basic_descriptor(io_service&) constructor`.
+Following the move, the moved-from object is in the same state as if constructed using the `basic_stream_descriptor(io_service&) constructor`.
@@ -68649,12 +71983,12 @@
[endsect]
-[section:bytes_readable posix::basic_descriptor::bytes_readable]
+[section:bytes_readable posix::basic_stream_descriptor::bytes_readable]
['Inherited from posix::descriptor_base.]
-[indexterm2 bytes_readable..posix::basic_descriptor]
+[indexterm2 bytes_readable..posix::basic_stream_descriptor]
IO control command to get the amount of data that can be read without blocking.
@@ -68683,7 +72017,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -68691,21 +72025,24 @@
[endsect]
-[section:cancel posix::basic_descriptor::cancel]
+[section:cancel posix::basic_stream_descriptor::cancel]
-[indexterm2 cancel..posix::basic_descriptor]
+[indexterm2 cancel..posix::basic_stream_descriptor]
Cancel all asynchronous operations associated with the descriptor.
- void ``[link boost_asio.reference.posix__basic_descriptor.cancel.overload1 cancel]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.cancel.overload1 more...]]``
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1 cancel]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.cancel.overload2 cancel]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2 cancel]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.cancel.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::cancel (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::cancel (1 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Cancel all asynchronous operations associated with the descriptor.
@@ -68733,7 +72070,10 @@
-[section:overload2 posix::basic_descriptor::cancel (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::cancel (2 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Cancel all asynchronous operations associated with the descriptor.
@@ -68763,21 +72103,24 @@
[endsect]
-[section:close posix::basic_descriptor::close]
+[section:close posix::basic_stream_descriptor::close]
-[indexterm2 close..posix::basic_descriptor]
+[indexterm2 close..posix::basic_stream_descriptor]
Close the descriptor.
- void ``[link boost_asio.reference.posix__basic_descriptor.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.close.overload1 more...]]``
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.close.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.close.overload2 close]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.close.overload2 close]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.close.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.close.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::close (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::close (1 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Close the descriptor.
@@ -68805,7 +72148,10 @@
-[section:overload2 posix::basic_descriptor::close (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::close (2 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Close the descriptor.
@@ -68835,20 +72181,20 @@
[endsect]
-[section:get_implementation posix::basic_descriptor::get_implementation]
+[section:get_implementation posix::basic_stream_descriptor::get_implementation]
-[indexterm2 get_implementation..posix::basic_descriptor]
+[indexterm2 get_implementation..posix::basic_stream_descriptor]
Get the underlying implementation of the I/O object.
- implementation_type & ``[link boost_asio.reference.posix__basic_descriptor.get_implementation.overload1 get_implementation]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_implementation.overload1 more...]]``
+ implementation_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload1 more...]]``
- const implementation_type & ``[link boost_asio.reference.posix__basic_descriptor.get_implementation.overload2 get_implementation]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_implementation.overload2 more...]]``
+ const implementation_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::get_implementation (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -68865,7 +72211,7 @@
-[section:overload2 posix::basic_descriptor::get_implementation (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -68884,12 +72230,12 @@
[endsect]
-[section:get_io_service posix::basic_descriptor::get_io_service]
+[section:get_io_service posix::basic_stream_descriptor::get_io_service]
['Inherited from basic_io_object.]
-[indexterm2 get_io_service..posix::basic_descriptor]
+[indexterm2 get_io_service..posix::basic_stream_descriptor]
Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
@@ -68909,20 +72255,20 @@
[endsect]
-[section:get_service posix::basic_descriptor::get_service]
+[section:get_service posix::basic_stream_descriptor::get_service]
-[indexterm2 get_service..posix::basic_descriptor]
+[indexterm2 get_service..posix::basic_stream_descriptor]
Get the service associated with the I/O object.
- service_type & ``[link boost_asio.reference.posix__basic_descriptor.get_service.overload1 get_service]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_service.overload1 more...]]``
+ service_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload1 more...]]``
- const service_type & ``[link boost_asio.reference.posix__basic_descriptor.get_service.overload2 get_service]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.get_service.overload2 more...]]``
+ const service_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::get_service (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::get_service (1 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -68939,7 +72285,7 @@
-[section:overload2 posix::basic_descriptor::get_service (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::get_service (2 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -68958,12 +72304,12 @@
[endsect]
-[section:implementation posix::basic_descriptor::implementation]
+[section:implementation posix::basic_stream_descriptor::implementation]
['Inherited from basic_io_object.]
-[indexterm2 implementation..posix::basic_descriptor]
+[indexterm2 implementation..posix::basic_stream_descriptor]
(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
@@ -68975,12 +72321,12 @@
-[section:implementation_type posix::basic_descriptor::implementation_type]
+[section:implementation_type posix::basic_stream_descriptor::implementation_type]
['Inherited from basic_io_object.]
-[indexterm2 implementation_type..posix::basic_descriptor]
+[indexterm2 implementation_type..posix::basic_stream_descriptor]
The underlying implementation type of I/O object.
@@ -68990,7 +72336,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -68998,27 +72344,26 @@
[endsect]
-[section:io_control posix::basic_descriptor::io_control]
+[section:io_control posix::basic_stream_descriptor::io_control]
-[indexterm2 io_control..posix::basic_descriptor]
+[indexterm2 io_control..posix::basic_stream_descriptor]
Perform an IO control command on the descriptor.
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- void ``[link boost_asio.reference.posix__basic_descriptor.io_control.overload1 io_control]``(
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1 io_control]``(
IoControlCommand & command);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.io_control.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.io_control.overload2 io_control]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2 io_control]``(
IoControlCommand & command,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.io_control.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::io_control (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::io_control (1 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Perform an IO control command on the descriptor.
@@ -69074,7 +72419,10 @@
-[section:overload2 posix::basic_descriptor::io_control (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::io_control (2 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Perform an IO control command on the descriptor.
@@ -69130,9 +72478,12 @@
[endsect]
-[section:is_open posix::basic_descriptor::is_open]
+[section:is_open posix::basic_stream_descriptor::is_open]
-[indexterm2 is_open..posix::basic_descriptor]
+
+['Inherited from posix::basic_descriptor.]
+
+[indexterm2 is_open..posix::basic_stream_descriptor]
Determine whether the descriptor is open.
@@ -69143,24 +72494,27 @@
[endsect]
-[section:lowest_layer posix::basic_descriptor::lowest_layer]
+[section:lowest_layer posix::basic_stream_descriptor::lowest_layer]
-[indexterm2 lowest_layer..posix::basic_descriptor]
+[indexterm2 lowest_layer..posix::basic_stream_descriptor]
Get a reference to the lowest layer.
- lowest_layer_type & ``[link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload1 more...]]``
+ lowest_layer_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1 more...]]``
Get a const reference to the lowest layer.
- const lowest_layer_type & ``[link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.lowest_layer.overload2 more...]]``
+ const lowest_layer_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2 more...]]``
-[section:overload1 posix::basic_descriptor::lowest_layer (1 of 2 overloads)]
+[section:overload1 posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Get a reference to the lowest layer.
@@ -69183,7 +72537,10 @@
-[section:overload2 posix::basic_descriptor::lowest_layer (2 of 2 overloads)]
+[section:overload2 posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Get a const reference to the lowest layer.
@@ -69208,13 +72565,16 @@
[endsect]
-[section:lowest_layer_type posix::basic_descriptor::lowest_layer_type]
+[section:lowest_layer_type posix::basic_stream_descriptor::lowest_layer_type]
-[indexterm2 lowest_layer_type..posix::basic_descriptor]
+
+['Inherited from posix::basic_descriptor.]
+
+[indexterm2 lowest_layer_type..posix::basic_stream_descriptor]
A [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] is always the lowest layer.
- typedef basic_descriptor< DescriptorService > lowest_layer_type;
+ typedef basic_descriptor< StreamDescriptorService > lowest_layer_type;
[heading Types]
@@ -69409,7 +72769,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -69418,9 +72778,12 @@
-[section:native posix::basic_descriptor::native]
+[section:native posix::basic_stream_descriptor::native]
-[indexterm2 native..posix::basic_descriptor]
+
+['Inherited from posix::basic_descriptor.]
+
+[indexterm2 native..posix::basic_stream_descriptor]
(Deprecated: Use `native_handle()`.) Get the native descriptor representation.
@@ -69434,9 +72797,12 @@
-[section:native_handle posix::basic_descriptor::native_handle]
+[section:native_handle posix::basic_stream_descriptor::native_handle]
-[indexterm2 native_handle..posix::basic_descriptor]
+
+['Inherited from posix::basic_descriptor.]
+
+[indexterm2 native_handle..posix::basic_stream_descriptor]
Get the native descriptor representation.
@@ -69450,19 +72816,19 @@
-[section:native_handle_type posix::basic_descriptor::native_handle_type]
+[section:native_handle_type posix::basic_stream_descriptor::native_handle_type]
-[indexterm2 native_handle_type..posix::basic_descriptor]
+[indexterm2 native_handle_type..posix::basic_stream_descriptor]
The native representation of a descriptor.
- typedef DescriptorService::native_handle_type native_handle_type;
+ typedef StreamDescriptorService::native_handle_type native_handle_type;
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -69470,30 +72836,33 @@
[endsect]
-[section:native_non_blocking posix::basic_descriptor::native_non_blocking]
+[section:native_non_blocking posix::basic_stream_descriptor::native_non_blocking]
-[indexterm2 native_non_blocking..posix::basic_descriptor]
+[indexterm2 native_non_blocking..posix::basic_stream_descriptor]
Gets the non-blocking mode of the native descriptor implementation.
- bool ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1 native_non_blocking]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload1 more...]]``
+ bool ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1 native_non_blocking]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1 more...]]``
Sets the non-blocking mode of the native descriptor implementation.
- void ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2 native_non_blocking]``(
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2 native_non_blocking]``(
bool mode);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3 native_non_blocking]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload3 native_non_blocking]``(
bool mode,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.native_non_blocking.overload3 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload3 more...]]``
-[section:overload1 posix::basic_descriptor::native_non_blocking (1 of 3 overloads)]
+[section:overload1 posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Gets the non-blocking mode of the native descriptor implementation.
@@ -69521,7 +72890,10 @@
-[section:overload2 posix::basic_descriptor::native_non_blocking (2 of 3 overloads)]
+[section:overload2 posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Sets the non-blocking mode of the native descriptor implementation.
@@ -69560,7 +72932,10 @@
-[section:overload3 posix::basic_descriptor::native_non_blocking (3 of 3 overloads)]
+[section:overload3 posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Sets the non-blocking mode of the native descriptor implementation.
@@ -69594,19 +72969,19 @@
[endsect]
-[section:native_type posix::basic_descriptor::native_type]
+[section:native_type posix::basic_stream_descriptor::native_type]
-[indexterm2 native_type..posix::basic_descriptor]
+[indexterm2 native_type..posix::basic_stream_descriptor]
(Deprecated: Use native\_handle\_type.) The native representation of a descriptor.
- typedef DescriptorService::native_handle_type native_type;
+ typedef StreamDescriptorService::native_handle_type native_type;
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -69614,30 +72989,33 @@
[endsect]
-[section:non_blocking posix::basic_descriptor::non_blocking]
+[section:non_blocking posix::basic_stream_descriptor::non_blocking]
-[indexterm2 non_blocking..posix::basic_descriptor]
+[indexterm2 non_blocking..posix::basic_stream_descriptor]
Gets the non-blocking mode of the descriptor.
- bool ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload1 non_blocking]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload1 more...]]``
+ bool ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1 non_blocking]``() const;
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1 more...]]``
Sets the non-blocking mode of the descriptor.
- void ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload2 non_blocking]``(
+ void ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2 non_blocking]``(
bool mode);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_descriptor.non_blocking.overload3 non_blocking]``(
+ boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3 non_blocking]``(
bool mode,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_descriptor.non_blocking.overload3 more...]]``
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3 more...]]``
-[section:overload1 posix::basic_descriptor::non_blocking (1 of 3 overloads)]
+[section:overload1 posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Gets the non-blocking mode of the descriptor.
@@ -69663,7 +73041,10 @@
-[section:overload2 posix::basic_descriptor::non_blocking (2 of 3 overloads)]
+[section:overload2 posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
Sets the non-blocking mode of the descriptor.
@@ -69705,33 +73086,433 @@
-[section:overload3 posix::basic_descriptor::non_blocking (3 of 3 overloads)]
+[section:overload3 posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)]
+
+
+['Inherited from posix::basic_descriptor.]
+
+
+Sets the non-blocking mode of the descriptor.
+
+
+ boost::system::error_code non_blocking(
+ bool mode,
+ boost::system::error_code & ec);
+
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
+
+]
+
+
+[heading Remarks]
+
+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`.
+
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:non_blocking_io posix::basic_stream_descriptor::non_blocking_io]
+
+
+['Inherited from posix::descriptor_base.]
+
+[indexterm2 non_blocking_io..posix::basic_stream_descriptor]
+(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
+
+
+ typedef implementation_defined non_blocking_io;
+
+
+
+Implements the FIONBIO IO control command.
+
+
+[heading Example]
+
+
+
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::descriptor_base::non_blocking_io command(true);
+ descriptor.io_control(command);
+
+
+
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:operator_eq_ posix::basic_stream_descriptor::operator=]
+
+[indexterm2 operator=..posix::basic_stream_descriptor]
+Move-assign a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
+
+
+ basic_stream_descriptor & operator=(
+ basic_stream_descriptor && other);
+
+
+This assignment operator moves a stream descriptor from one object to another.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[other][The other [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] object from which the move will occur.]]
+
+]
+
+
+[heading Remarks]
+
+Following the move, the moved-from object is in the same state as if constructed using the `basic_stream_descriptor(io_service&) constructor`.
+
+
+
+
+[endsect]
+
+
+[section:read_some posix::basic_stream_descriptor::read_some]
+
+[indexterm2 read_some..posix::basic_stream_descriptor]
+Read some data from the descriptor.
+
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1 read_some]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2 read_some]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2 more...]]``
+
+
+[section:overload1 posix::basic_stream_descriptor::read_some (1 of 2 overloads)]
+
+
+Read some data from the descriptor.
+
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers);
+
+
+This function is used to read data from the stream descriptor. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[buffers][One or more buffers into which the data will be read.]]
+
+]
+
+
+[heading Return Value]
+
+The number of bytes read.
+
+
+[heading Exceptions]
+
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. An error code of `boost::asio::error::eof` indicates that the connection was closed by the peer.]]
+
+]
+
+
+[heading Remarks]
+
+The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+
+
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+
+ descriptor.read_some(boost::asio::buffer(data, size));
+
+
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+
+
+
+
+[endsect]
+
+
+
+[section:overload2 posix::basic_stream_descriptor::read_some (2 of 2 overloads)]
+
+
+Read some data from the descriptor.
+
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+
+
+This function is used to read data from the stream descriptor. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[buffers][One or more buffers into which the data will be read.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
+
+]
+
+
+[heading Return Value]
+
+The number of bytes read. Returns 0 if an error occurred.
+
+
+[heading Remarks]
+
+The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:release posix::basic_stream_descriptor::release]
+
+
+['Inherited from posix::basic_descriptor.]
+
+[indexterm2 release..posix::basic_stream_descriptor]
+Release ownership of the native descriptor implementation.
+
+
+ native_handle_type release();
+
+
+This function may be used to obtain the underlying representation of the descriptor. After calling this function, `is_open()` returns false. The caller is responsible for closing the descriptor.
+
+All outstanding asynchronous read or write operations will finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
+
+
+[endsect]
+
+
+
+[section:service posix::basic_stream_descriptor::service]
+
+
+['Inherited from basic_io_object.]
+
+[indexterm2 service..posix::basic_stream_descriptor]
+(Deprecated: Use `get_service()`.) The service associated with the I/O object.
+
+
+ service_type & service;
+
+
+
+[heading Remarks]
+
+Available only for services that do not support movability.
+
+
+
+
+[endsect]
+
+
+
+[section:service_type posix::basic_stream_descriptor::service_type]
+
+
+['Inherited from basic_io_object.]
+
+[indexterm2 service_type..posix::basic_stream_descriptor]
+The type of the service that will be used to provide I/O operations.
+
+
+ typedef StreamDescriptorService service_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:write_some posix::basic_stream_descriptor::write_some]
+
+[indexterm2 write_some..posix::basic_stream_descriptor]
+Write some data to the descriptor.
+
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1 write_some]``(
+ const ConstBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2 write_some]``(
+ const ConstBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2 more...]]``
+
+
+[section:overload1 posix::basic_stream_descriptor::write_some (1 of 2 overloads)]
+
+
+Write some data to the descriptor.
+
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers);
+
+
+This function is used to write data to the stream descriptor. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[buffers][One or more data buffers to be written to the descriptor.]]
+
+]
+
+
+[heading Return Value]
+
+The number of bytes written.
+
+
+[heading Exceptions]
+
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. An error code of `boost::asio::error::eof` indicates that the connection was closed by the peer.]]
+
+]
+
+
+[heading Remarks]
+
+The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
+
+
+[heading Example]
+
+To write a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+
+ descriptor.write_some(boost::asio::buffer(data, size));
+
+
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+
+
+
+
+[endsect]
+
+
+
+[section:overload2 posix::basic_stream_descriptor::write_some (2 of 2 overloads)]
-Sets the non-blocking mode of the descriptor.
+Write some data to the descriptor.
- boost::system::error_code non_blocking(
- bool mode,
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers,
boost::system::error_code & ec);
+This function is used to write data to the stream descriptor. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.
+
[heading Parameters]
[variablelist
-[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
+[[buffers][One or more data buffers to be written to the descriptor.]]
[[ec][Set to indicate what error occurred, if any.]]
]
+[heading Return Value]
+
+The number of bytes written. Returns 0 if an error occurred.
+
+
[heading Remarks]
-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`.
+The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
@@ -69742,140 +73523,126 @@
[endsect]
-[section:non_blocking_io posix::basic_descriptor::non_blocking_io]
-
+[endsect]
-['Inherited from posix::descriptor_base.]
+[section:posix__descriptor_base posix::descriptor_base]
-[indexterm2 non_blocking_io..posix::basic_descriptor]
-(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
+The [link boost_asio.reference.posix__descriptor_base `posix::descriptor_base`] class is used as a base for the [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template so that we have a common place to define the associated IO control commands.
- typedef implementation_defined non_blocking_io;
+ class descriptor_base
-Implements the FIONBIO IO control command.
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[heading Example]
+ [[link boost_asio.reference.posix__descriptor_base.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
+ ]
+ [
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::descriptor_base::non_blocking_io command(true);
- descriptor.io_control(command);
-
-
-
+ [[link boost_asio.reference.posix__descriptor_base.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
+
+ ]
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.posix__descriptor_base._descriptor_base [*~descriptor_base]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
+]
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/descriptor_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
-
-
-
-[section:operator_eq_ posix::basic_descriptor::operator=]
+[section:bytes_readable posix::descriptor_base::bytes_readable]
-[indexterm2 operator=..posix::basic_descriptor]
-Move-assign a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] from another.
+[indexterm2 bytes_readable..posix::descriptor_base]
+IO control command to get the amount of data that can be read without blocking.
- basic_descriptor & operator=(
- basic_descriptor && other);
+ typedef implementation_defined bytes_readable;
-This assignment operator moves a descriptor from one object to another.
+Implements the FIONREAD IO control command.
-[heading Parameters]
-
-[variablelist
+[heading Example]
-[[other][The other [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] object from which the move will occur.]]
-
-]
-
-
-[heading Remarks]
-
-Following the move, the moved-from object is in the same state as if constructed using the `basic_descriptor(io_service&) constructor`.
-
-
-[endsect]
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::descriptor_base::bytes_readable command(true);
+ descriptor.io_control(command);
+ std::size_t bytes_readable = command.get();
-[section:release posix::basic_descriptor::release]
-[indexterm2 release..posix::basic_descriptor]
-Release ownership of the native descriptor implementation.
- native_handle_type release();
+[heading Requirements]
-This function may be used to obtain the underlying representation of the descriptor. After calling this function, `is_open()` returns false. The caller is responsible for closing the descriptor.
+[*Header: ][^boost/asio/posix/descriptor_base.hpp]
-All outstanding asynchronous read or write operations will finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:service posix::basic_descriptor::service]
-
-
-['Inherited from basic_io_object.]
-
-[indexterm2 service..posix::basic_descriptor]
-(Deprecated: Use `get_service()`.) The service associated with the I/O object.
-
-
- service_type & service;
-
+[section:non_blocking_io posix::descriptor_base::non_blocking_io]
+[indexterm2 non_blocking_io..posix::descriptor_base]
+(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
-[heading Remarks]
-
-Available only for services that do not support movability.
+ typedef implementation_defined non_blocking_io;
-[endsect]
+Implements the FIONBIO IO control command.
+[heading Example]
+
-[section:service_type posix::basic_descriptor::service_type]
+ boost::asio::posix::stream_descriptor descriptor(io_service);
+ ...
+ boost::asio::descriptor_base::non_blocking_io command(true);
+ descriptor.io_control(command);
-['Inherited from basic_io_object.]
-[indexterm2 service_type..posix::basic_descriptor]
-The type of the service that will be used to provide I/O operations.
- typedef DescriptorService service_type;
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_descriptor.hpp]
+[*Header: ][^boost/asio/posix/descriptor_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -69884,13 +73651,13 @@
-[section:_basic_descriptor posix::basic_descriptor::~basic_descriptor]
+[section:_descriptor_base posix::descriptor_base::~descriptor_base]
-[indexterm2 ~basic_descriptor..posix::basic_descriptor]
+[indexterm2 ~descriptor_base..posix::descriptor_base]
Protected destructor to prevent deletion through this type.
- ~basic_descriptor();
+ ~descriptor_base();
@@ -69900,16 +73667,14 @@
[endsect]
-[section:posix__basic_stream_descriptor posix::basic_stream_descriptor]
+[section:posix__stream_descriptor posix::stream_descriptor]
-Provides stream-oriented descriptor functionality.
+[indexterm1 posix::stream_descriptor]
+Typedef for the typical usage of a stream-oriented descriptor.
- template<
- typename ``[link boost_asio.reference.StreamDescriptorService StreamDescriptorService]`` = stream_descriptor_service>
- class basic_stream_descriptor :
- public posix::basic_descriptor< StreamDescriptorService >
+ typedef basic_stream_descriptor stream_descriptor;
[heading Types]
@@ -70008,582 +73773,388 @@
[
[[link boost_asio.reference.posix__basic_stream_descriptor.get_io_service [*get_io_service]]]
[Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.io_control [*io_control]]]
- [Perform an IO control command on the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.is_open [*is_open]]]
- [Determine whether the descriptor is open. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
-
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle [*native_handle]]]
- [Get the native descriptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native descriptor implementation.
-
- Sets the non-blocking mode of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the descriptor.
-
- Sets the non-blocking mode of the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_stream_descriptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.read_some [*read_some]]]
- [Read some data from the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.release [*release]]]
- [Release ownership of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.write_some [*write_some]]]
- [Write some data to the descriptor. ]
- ]
-
-]
-
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
-
-[heading Protected Data Members]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-
-]
-
-The [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template provides asynchronous and blocking stream-oriented descriptor functionality.
-
-
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-
-[*Shared] [*objects:] Unsafe.
-
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-[section:assign posix::basic_stream_descriptor::assign]
-
-[indexterm2 assign..posix::basic_stream_descriptor]
-Assign an existing native descriptor to the descriptor.
-
-
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.assign.overload1 assign]``(
- const native_handle_type & native_descriptor);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.assign.overload1 more...]]``
-
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.assign.overload2 assign]``(
- const native_handle_type & native_descriptor,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.assign.overload2 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::assign (1 of 2 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
-
-
-Assign an existing native descriptor to the descriptor.
-
-
- void assign(
- const native_handle_type & native_descriptor);
-
-
-
-[endsect]
-
-
-
-[section:overload2 posix::basic_stream_descriptor::assign (2 of 2 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
-
-
-Assign an existing native descriptor to the descriptor.
-
-
- boost::system::error_code assign(
- const native_handle_type & native_descriptor,
- boost::system::error_code & ec);
-
-
-
-[endsect]
-
-
-[endsect]
-
-
-[section:async_read_some posix::basic_stream_descriptor::async_read_some]
-
-[indexterm2 async_read_some..posix::basic_stream_descriptor]
-Start an asynchronous read.
-
-
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- const MutableBufferSequence & buffers,
- ReadHandler handler);
-
-
-This function is used to asynchronously read data from the stream descriptor. The function call always returns immediately.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[buffers][One or more buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
-
-[[handler][The handler to be called when the read operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- std::size_t bytes_transferred // Number of bytes read.
- );
-``
-Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
-
-]
-
-
-[heading Remarks]
-
-The read operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.async_read `async_read`] function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.
-
-
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
-
- descriptor.async_read_some(boost::asio::buffer(data, size), handler);
-
-
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-
-
-
-
-[endsect]
-
-
-
-[section:async_write_some posix::basic_stream_descriptor::async_write_some]
-
-[indexterm2 async_write_some..posix::basic_stream_descriptor]
-Start an asynchronous write.
-
-
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- const ConstBufferSequence & buffers,
- WriteHandler handler);
-
-
-This function is used to asynchronously write data to the stream descriptor. The function call always returns immediately.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[buffers][One or more data buffers to be written to the descriptor. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
-
-[[handler][The handler to be called when the write operation completes. Copies will be made of the handler as required. The function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- std::size_t bytes_transferred // Number of bytes written.
- );
-``
-Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`.]]
-
-]
-
-
-[heading Remarks]
-
-The write operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.async_write `async_write`] function if you need to ensure that all data is written before the asynchronous operation completes.
-
-
-[heading Example]
-
-To write a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
-
- descriptor.async_write_some(boost::asio::buffer(data, size), handler);
-
-
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-
-
-
-
-[endsect]
-
-
-[section:basic_stream_descriptor posix::basic_stream_descriptor::basic_stream_descriptor]
-
-[indexterm2 basic_stream_descriptor..posix::basic_stream_descriptor]
-Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] without opening it.
-
-
- explicit ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1 basic_stream_descriptor]``(
- boost::asio::io_service & io_service);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload1 more...]]``
-
-
-Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] on an existing native descriptor.
-
-
- ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2 basic_stream_descriptor]``(
- boost::asio::io_service & io_service,
- const native_handle_type & native_descriptor);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload2 more...]]``
-
-
-Move-construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
-
-
- ``[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3 basic_stream_descriptor]``(
- basic_stream_descriptor && other);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor.overload3 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::basic_stream_descriptor (1 of 3 overloads)]
-
-
-Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] without opening it.
-
-
- basic_stream_descriptor(
- boost::asio::io_service & io_service);
-
-
-This constructor creates a stream descriptor without opening it. The descriptor needs to be opened and then connected or accepted before data can be sent or received on it.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the stream descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor. ]]
-
-]
-
-
-
-
-[endsect]
-
-
-
-[section:overload2 posix::basic_stream_descriptor::basic_stream_descriptor (2 of 3 overloads)]
-
-
-Construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] on an existing native descriptor.
-
-
- basic_stream_descriptor(
- boost::asio::io_service & io_service,
- const native_handle_type & native_descriptor);
-
-
-This constructor creates a stream descriptor object to hold an existing native descriptor.
-
-
-[heading Parameters]
-
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.io_control [*io_control]]]
+ [Perform an IO control command on the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.is_open [*is_open]]]
+ [Determine whether the descriptor is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
-[variablelist
+ Get a const reference to the lowest layer. ]
+ ]
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the stream descriptor will use to dispatch handlers for any asynchronous operations performed on the descriptor.]]
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle [*native_handle]]]
+ [Get the native descriptor representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native descriptor implementation.
-[[native_descriptor][The new underlying descriptor implementation.]]
+ Sets the non-blocking mode of the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the descriptor.
+ Sets the non-blocking mode of the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.operator_eq_ [*operator=]]]
+ [Move-assign a basic_stream_descriptor from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.read_some [*read_some]]]
+ [Read some data from the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.release [*release]]]
+ [Release ownership of the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.write_some [*write_some]]]
+ [Write some data to the descriptor. ]
+ ]
+
]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[heading Exceptions]
-
-
-[variablelist
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
-[[boost::system::system_error][Thrown on failure. ]]
-
]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+ [
+ [[link boost_asio.reference.posix__basic_stream_descriptor.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
-[endsect]
-
-
-
-[section:overload3 posix::basic_stream_descriptor::basic_stream_descriptor (3 of 3 overloads)]
-
-
-Move-construct a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
-
+]
- basic_stream_descriptor(
- basic_stream_descriptor && other);
+The [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template provides asynchronous and blocking stream-oriented descriptor functionality.
-This constructor moves a stream descriptor from one object to another.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-[heading Parameters]
-
-[variablelist
-
-[[other][The other [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] object from which the move will occur.]]
-]
-[heading Remarks]
-
-Following the move, the moved-from object is in the same state as if constructed using the `basic_stream_descriptor(io_service&) constructor`.
+[heading Requirements]
+[*Header: ][^boost/asio/posix/stream_descriptor.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
+[section:posix__stream_descriptor_service posix::stream_descriptor_service]
-[section:bytes_readable posix::basic_stream_descriptor::bytes_readable]
+Default service implementation for a stream descriptor.
-['Inherited from posix::descriptor_base.]
+ class stream_descriptor_service :
+ public io_service::service
-[indexterm2 bytes_readable..posix::basic_stream_descriptor]
-IO control command to get the amount of data that can be read without blocking.
+[heading Types]
+[table
+ [[Name][Description]]
- typedef implementation_defined bytes_readable;
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.implementation_type [*implementation_type]]]
+ [The type of a stream descriptor implementation. ]
+
+ ]
+ [
-Implements the FIONREAD IO control command.
+ [[link boost_asio.reference.posix__stream_descriptor_service.native_handle_type [*native_handle_type]]]
+ [The native descriptor type. ]
+
+ ]
+ [
-[heading Example]
+ [[link boost_asio.reference.posix__stream_descriptor_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native descriptor type. ]
+ ]
+]
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::descriptor_base::bytes_readable command(true);
- descriptor.io_control(command);
- std::size_t bytes_readable = command.get();
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.assign [*assign]]]
+ [Assign an existing native descriptor to a stream descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.close [*close]]]
+ [Close a stream descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.construct [*construct]]]
+ [Construct a new stream descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.destroy [*destroy]]]
+ [Destroy a stream descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.io_control [*io_control]]]
+ [Perform an IO control command on the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.is_open [*is_open]]]
+ [Determine whether the descriptor is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.move_assign [*move_assign]]]
+ [Move-assign from another stream descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.move_construct [*move_construct]]]
+ [Move-construct a new stream descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.native_handle [*native_handle]]]
+ [Get the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native descriptor implementation.
+ Sets the non-blocking mode of the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the descriptor.
+ Sets the non-blocking mode of the descriptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.read_some [*read_some]]]
+ [Read some data from the stream. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.release [*release]]]
+ [Release ownership of the native descriptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.stream_descriptor_service [*stream_descriptor_service]]]
+ [Construct a new stream descriptor service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.write_some [*write_some]]]
+ [Write the given data to the stream. ]
+ ]
+
+]
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.posix__stream_descriptor_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+]
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
-
-
-[section:cancel posix::basic_stream_descriptor::cancel]
-
-[indexterm2 cancel..posix::basic_stream_descriptor]
-Cancel all asynchronous operations associated with the descriptor.
+[section:assign posix::stream_descriptor_service::assign]
+[indexterm2 assign..posix::stream_descriptor_service]
+Assign an existing native descriptor to a stream descriptor.
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1 cancel]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2 cancel]``(
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const native_handle_type & native_descriptor,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.cancel.overload2 more...]]``
-[section:overload1 posix::basic_stream_descriptor::cancel (1 of 2 overloads)]
+[endsect]
-['Inherited from posix::basic_descriptor.]
-Cancel all asynchronous operations associated with the descriptor.
+[section:async_read_some posix::stream_descriptor_service::async_read_some]
+[indexterm2 async_read_some..posix::stream_descriptor_service]
+Start an asynchronous read.
- void cancel();
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
-This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
-[heading Exceptions]
-
+[endsect]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
-]
+[section:async_write_some posix::stream_descriptor_service::async_write_some]
+[indexterm2 async_write_some..posix::stream_descriptor_service]
+Start an asynchronous write.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
-[section:overload2 posix::basic_stream_descriptor::cancel (2 of 2 overloads)]
+[endsect]
-['Inherited from posix::basic_descriptor.]
+[section:cancel posix::stream_descriptor_service::cancel]
+[indexterm2 cancel..posix::stream_descriptor_service]
Cancel all asynchronous operations associated with the descriptor.
boost::system::error_code cancel(
+ implementation_type & impl,
boost::system::error_code & ec);
-This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any. ]]
-
-]
-
-
-
[endsect]
-[endsect]
-
-[section:close posix::basic_stream_descriptor::close]
-[indexterm2 close..posix::basic_stream_descriptor]
-Close the descriptor.
+[section:close posix::stream_descriptor_service::close]
+[indexterm2 close..posix::stream_descriptor_service]
+Close a stream descriptor implementation.
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.close.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.close.overload2 close]``(
+ boost::system::error_code close(
+ implementation_type & impl,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.close.overload2 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::close (1 of 2 overloads)]
-['Inherited from posix::basic_descriptor.]
-
-
-Close the descriptor.
-
-
- void close();
+[endsect]
-This function is used to close the descriptor. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
-[heading Exceptions]
-
+[section:construct posix::stream_descriptor_service::construct]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. Note that, even if the function indicates an error, the underlying descriptor is closed. ]]
+[indexterm2 construct..posix::stream_descriptor_service]
+Construct a new stream descriptor implementation.
-]
+ void construct(
+ implementation_type & impl);
@@ -70591,62 +74162,45 @@
-[section:overload2 posix::basic_stream_descriptor::close (2 of 2 overloads)]
-
+[section:destroy posix::stream_descriptor_service::destroy]
-['Inherited from posix::basic_descriptor.]
+[indexterm2 destroy..posix::stream_descriptor_service]
+Destroy a stream descriptor implementation.
-Close the descriptor.
+ void destroy(
+ implementation_type & impl);
- boost::system::error_code close(
- boost::system::error_code & ec);
+[endsect]
-This function is used to close the descriptor. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
-[heading Parameters]
-
+[section:get_io_service posix::stream_descriptor_service::get_io_service]
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any. Note that, even if the function indicates an error, the underlying descriptor is closed. ]]
-]
+['Inherited from io_service.]
+[indexterm2 get_io_service..posix::stream_descriptor_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ boost::asio::io_service & get_io_service();
-[endsect]
[endsect]
-[section:get_implementation posix::basic_stream_descriptor::get_implementation]
-
-[indexterm2 get_implementation..posix::basic_stream_descriptor]
-Get the underlying implementation of the I/O object.
-
-
- implementation_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload1 get_implementation]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload1 more...]]``
-
- const implementation_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload2 get_implementation]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_implementation.overload2 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::get_implementation (1 of 2 overloads)]
-
-['Inherited from basic_io_object.]
+[section:id posix::stream_descriptor_service::id]
-Get the underlying implementation of the I/O object.
+[indexterm2 id..posix::stream_descriptor_service]
+The unique service identifier.
- implementation_type & get_implementation();
+ static boost::asio::io_service::id id;
@@ -70654,109 +74208,102 @@
-[section:overload2 posix::basic_stream_descriptor::get_implementation (2 of 2 overloads)]
-
+[section:implementation_type posix::stream_descriptor_service::implementation_type]
-['Inherited from basic_io_object.]
+[indexterm2 implementation_type..posix::stream_descriptor_service]
+The type of a stream descriptor implementation.
-Get the underlying implementation of the I/O object.
+ typedef implementation_defined implementation_type;
- const implementation_type & get_implementation() const;
+[heading Requirements]
+[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:get_io_service posix::basic_stream_descriptor::get_io_service]
-
-
-['Inherited from basic_io_object.]
-
-[indexterm2 get_io_service..posix::basic_stream_descriptor]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
-
-
- boost::asio::io_service & get_io_service();
-
-This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
+[section:io_control posix::stream_descriptor_service::io_control]
+[indexterm2 io_control..posix::stream_descriptor_service]
+Perform an IO control command on the descriptor.
-[heading Return Value]
-
-A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
+ boost::system::error_code & ec);
[endsect]
-[section:get_service posix::basic_stream_descriptor::get_service]
-
-[indexterm2 get_service..posix::basic_stream_descriptor]
-Get the service associated with the I/O object.
-
-
- service_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload1 get_service]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload1 more...]]``
-
- const service_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload2 get_service]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.get_service.overload2 more...]]``
+[section:is_open posix::stream_descriptor_service::is_open]
-[section:overload1 posix::basic_stream_descriptor::get_service (1 of 2 overloads)]
+[indexterm2 is_open..posix::stream_descriptor_service]
+Determine whether the descriptor is open.
-['Inherited from basic_io_object.]
+ bool is_open(
+ const implementation_type & impl) const;
-Get the service associated with the I/O object.
+[endsect]
- service_type & get_service();
+[section:move_assign posix::stream_descriptor_service::move_assign]
-[endsect]
+[indexterm2 move_assign..posix::stream_descriptor_service]
+Move-assign from another stream descriptor implementation.
+ void move_assign(
+ implementation_type & impl,
+ stream_descriptor_service & other_service,
+ implementation_type & other_impl);
-[section:overload2 posix::basic_stream_descriptor::get_service (2 of 2 overloads)]
-['Inherited from basic_io_object.]
+[endsect]
-Get the service associated with the I/O object.
+[section:move_construct posix::stream_descriptor_service::move_construct]
- const service_type & get_service() const;
+[indexterm2 move_construct..posix::stream_descriptor_service]
+Move-construct a new stream descriptor implementation.
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
-[endsect]
[endsect]
-[section:implementation posix::basic_stream_descriptor::implementation]
-
-['Inherited from basic_io_object.]
+[section:native posix::stream_descriptor_service::native]
-[indexterm2 implementation..posix::basic_stream_descriptor]
-(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
+[indexterm2 native..posix::stream_descriptor_service]
+(Deprecated: Use `native_handle()`.) Get the native descriptor implementation.
- implementation_type implementation;
+ native_type native(
+ implementation_type & impl);
@@ -70764,215 +74311,198 @@
-[section:implementation_type posix::basic_stream_descriptor::implementation_type]
+[section:native_handle posix::stream_descriptor_service::native_handle]
+[indexterm2 native_handle..posix::stream_descriptor_service]
+Get the native descriptor implementation.
-['Inherited from basic_io_object.]
-[indexterm2 implementation_type..posix::basic_stream_descriptor]
-The underlying implementation type of I/O object.
+ native_handle_type native_handle(
+ implementation_type & impl);
- typedef service_type::implementation_type implementation_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+[section:native_handle_type posix::stream_descriptor_service::native_handle_type]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 native_handle_type..posix::stream_descriptor_service]
+The native descriptor type.
-[endsect]
+ typedef implementation_defined native_handle_type;
-[section:io_control posix::basic_stream_descriptor::io_control]
-[indexterm2 io_control..posix::basic_stream_descriptor]
-Perform an IO control command on the descriptor.
+[heading Requirements]
+[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1 io_control]``(
- IoControlCommand & command);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload1 more...]]``
+[*Convenience header: ][^boost/asio.hpp]
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2 io_control]``(
- IoControlCommand & command,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.io_control.overload2 more...]]``
+[endsect]
-[section:overload1 posix::basic_stream_descriptor::io_control (1 of 2 overloads)]
+[section:native_non_blocking posix::stream_descriptor_service::native_non_blocking]
-['Inherited from posix::basic_descriptor.]
+[indexterm2 native_non_blocking..posix::stream_descriptor_service]
+Gets the non-blocking mode of the native descriptor implementation.
-Perform an IO control command on the descriptor.
+ bool ``[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- void io_control(
- IoControlCommand & command);
+Sets the non-blocking mode of the native descriptor implementation.
-This function is used to execute an IO control command on the descriptor.
+ boost::system::error_code ``[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload2 more...]]``
-[heading Parameters]
-
+[section:overload1 posix::stream_descriptor_service::native_non_blocking (1 of 2 overloads)]
-[variablelist
-
-[[command][The IO control command to be performed on the descriptor.]]
-]
+Gets the non-blocking mode of the native descriptor implementation.
-[heading Exceptions]
-
+ bool native_non_blocking(
+ const implementation_type & impl) const;
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[endsect]
-[heading Example]
-
-Getting the number of bytes ready to read:
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::posix::stream_descriptor::bytes_readable command;
- descriptor.io_control(command);
- std::size_t bytes_readable = command.get();
+[section:overload2 posix::stream_descriptor_service::native_non_blocking (2 of 2 overloads)]
+Sets the non-blocking mode of the native descriptor implementation.
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
[endsect]
-
-[section:overload2 posix::basic_stream_descriptor::io_control (2 of 2 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
+[endsect]
-Perform an IO control command on the descriptor.
+[section:native_type posix::stream_descriptor_service::native_type]
+[indexterm2 native_type..posix::stream_descriptor_service]
+(Deprecated: Use native\_handle\_type.) The native descriptor type.
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- IoControlCommand & command,
- boost::system::error_code & ec);
+ typedef implementation_defined native_type;
-This function is used to execute an IO control command on the descriptor.
-[heading Parameters]
-
+[heading Requirements]
-[variablelist
-
-[[command][The IO control command to be performed on the descriptor.]]
+[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
-[[ec][Set to indicate what error occurred, if any.]]
+[*Convenience header: ][^boost/asio.hpp]
-]
+[endsect]
-[heading Example]
-
-Getting the number of bytes ready to read:
+[section:non_blocking posix::stream_descriptor_service::non_blocking]
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::posix::stream_descriptor::bytes_readable command;
- boost::system::error_code ec;
- descriptor.io_control(command, ec);
- if (ec)
- {
- // An error occurred.
- }
- std::size_t bytes_readable = command.get();
+[indexterm2 non_blocking..posix::stream_descriptor_service]
+Gets the non-blocking mode of the descriptor.
+ bool ``[link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload1 more...]]``
+Sets the non-blocking mode of the descriptor.
+ boost::system::error_code ``[link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload2 more...]]``
-[endsect]
+[section:overload1 posix::stream_descriptor_service::non_blocking (1 of 2 overloads)]
-[endsect]
+Gets the non-blocking mode of the descriptor.
-[section:is_open posix::basic_stream_descriptor::is_open]
+ bool non_blocking(
+ const implementation_type & impl) const;
-['Inherited from posix::basic_descriptor.]
-[indexterm2 is_open..posix::basic_stream_descriptor]
-Determine whether the descriptor is open.
+[endsect]
- bool is_open() const;
+[section:overload2 posix::stream_descriptor_service::non_blocking (2 of 2 overloads)]
-[endsect]
+Sets the non-blocking mode of the descriptor.
-[section:lowest_layer posix::basic_stream_descriptor::lowest_layer]
-[indexterm2 lowest_layer..posix::basic_stream_descriptor]
-Get a reference to the lowest layer.
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
- lowest_layer_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload1 more...]]``
+[endsect]
-Get a const reference to the lowest layer.
+[endsect]
- const lowest_layer_type & ``[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer.overload2 more...]]``
+[section:read_some posix::stream_descriptor_service::read_some]
-[section:overload1 posix::basic_stream_descriptor::lowest_layer (1 of 2 overloads)]
+[indexterm2 read_some..posix::stream_descriptor_service]
+Read some data from the stream.
-['Inherited from posix::basic_descriptor.]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
-Get a reference to the lowest layer.
+[endsect]
- lowest_layer_type & lowest_layer();
-This function returns a reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] cannot contain any further layers, it simply returns a reference to itself.
+[section:release posix::stream_descriptor_service::release]
+[indexterm2 release..posix::stream_descriptor_service]
+Release ownership of the native descriptor implementation.
-[heading Return Value]
-
-A reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
+ native_handle_type release(
+ implementation_type & impl);
@@ -70980,44 +74510,52 @@
-[section:overload2 posix::basic_stream_descriptor::lowest_layer (2 of 2 overloads)]
-
+[section:stream_descriptor_service posix::stream_descriptor_service::stream_descriptor_service]
-['Inherited from posix::basic_descriptor.]
+[indexterm2 stream_descriptor_service..posix::stream_descriptor_service]
+Construct a new stream descriptor service for the specified [link boost_asio.reference.io_service `io_service`].
-Get a const reference to the lowest layer.
+ stream_descriptor_service(
+ boost::asio::io_service & io_service);
- const lowest_layer_type & lowest_layer() const;
+[endsect]
-This function returns a const reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] cannot contain any further layers, it simply returns a reference to itself.
-[heading Return Value]
-
-A const reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
+[section:write_some posix::stream_descriptor_service::write_some]
+[indexterm2 write_some..posix::stream_descriptor_service]
+Write the given data to the stream.
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ boost::system::error_code & ec);
-[endsect]
[endsect]
-[section:lowest_layer_type posix::basic_stream_descriptor::lowest_layer_type]
+[endsect]
-['Inherited from posix::basic_descriptor.]
+[section:raw_socket_service raw_socket_service]
-[indexterm2 lowest_layer_type..posix::basic_stream_descriptor]
-A [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] is always the lowest layer.
+Default service implementation for a raw socket.
- typedef basic_descriptor< StreamDescriptorService > lowest_layer_type;
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class raw_socket_service :
+ public io_service::service
[heading Types]
@@ -71026,50 +74564,36 @@
[
- [[link boost_asio.reference.posix__basic_descriptor.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.posix__basic_descriptor.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.posix__basic_descriptor.lowest_layer_type [*lowest_layer_type]]]
- [A basic_descriptor is always the lowest layer. ]
+ [[link boost_asio.reference.raw_socket_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_handle_type [*native_handle_type]]]
- [The native representation of a descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.implementation_type [*implementation_type]]]
+ [The type of a raw socket. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.native_handle_type [*native_handle_type]]]
+ [The native socket type. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native socket type. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.raw_socket_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
]
@@ -71080,252 +74604,229 @@
[[Name][Description]]
[
- [[link boost_asio.reference.posix__basic_descriptor.assign [*assign]]]
- [Assign an existing native descriptor to the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.assign [*assign]]]
+ [Assign an existing native socket to a raw socket. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.basic_descriptor [*basic_descriptor]]]
- [Construct a basic_descriptor without opening it.
-
- Construct a basic_descriptor on an existing native descriptor.
-
- Move-construct a basic_descriptor from another. ]
+ [[link boost_asio.reference.raw_socket_service.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.close [*close]]]
- [Close the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.async_receive_from [*async_receive_from]]]
+ [Start an asynchronous receive that will get the endpoint of the sender. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.raw_socket_service.async_send [*async_send]]]
+ [Start an asynchronous send. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.io_control [*io_control]]]
- [Perform an IO control command on the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.async_send_to [*async_send_to]]]
+ [Start an asynchronous send. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.is_open [*is_open]]]
- [Determine whether the descriptor is open. ]
+ [[link boost_asio.reference.raw_socket_service.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
-
- Get a const reference to the lowest layer. ]
+ [[link boost_asio.reference.raw_socket_service.available [*available]]]
+ [Determine the number of bytes available for reading. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
+ [[link boost_asio.reference.raw_socket_service.bind [*bind]]]
+ []
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_handle [*native_handle]]]
- [Get the native descriptor representation. ]
+ [[link boost_asio.reference.raw_socket_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native descriptor implementation.
-
- Sets the non-blocking mode of the native descriptor implementation. ]
+ [[link boost_asio.reference.raw_socket_service.close [*close]]]
+ [Close a raw socket implementation. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the descriptor.
-
- Sets the non-blocking mode of the descriptor. ]
+ [[link boost_asio.reference.raw_socket_service.connect [*connect]]]
+ [Connect the raw socket to the specified endpoint. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_descriptor from another. ]
+ [[link boost_asio.reference.raw_socket_service.construct [*construct]]]
+ [Construct a new raw socket implementation. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.release [*release]]]
- [Release ownership of the native descriptor implementation. ]
+ [[link boost_asio.reference.raw_socket_service.destroy [*destroy]]]
+ [Destroy a raw socket implementation. ]
]
-]
-
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.posix__basic_descriptor.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.raw_socket_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
+ [[link boost_asio.reference.raw_socket_service.get_option [*get_option]]]
+ [Get a socket option. ]
]
[
- [[link boost_asio.reference.posix__basic_descriptor._basic_descriptor [*~basic_descriptor]]]
- [Protected destructor to prevent deletion through this type. ]
+ [[link boost_asio.reference.raw_socket_service.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
]
-]
-
-[heading Protected Data Members]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.posix__basic_descriptor.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.raw_socket_service.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
]
-
+
[
- [[link boost_asio.reference.posix__basic_descriptor.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ [[link boost_asio.reference.raw_socket_service.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint. ]
]
-
-]
-
-The [link boost_asio.reference.posix__basic_descriptor `posix::basic_descriptor`] class template provides the ability to wrap a POSIX descriptor.
-
-
-[heading Thread Safety]
-[*Distinct] [*objects:] Safe.
-
-[*Shared] [*objects:] Unsafe.
-
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-
-[section:native posix::basic_stream_descriptor::native]
-
-
-['Inherited from posix::basic_descriptor.]
-
-[indexterm2 native..posix::basic_stream_descriptor]
-(Deprecated: Use `native_handle()`.) Get the native descriptor representation.
-
-
- native_type native();
-
-
-This function may be used to obtain the underlying representation of the descriptor. This is intended to allow access to native descriptor functionality that is not otherwise provided.
-
-
-[endsect]
-
-
-
-[section:native_handle posix::basic_stream_descriptor::native_handle]
-
-
-['Inherited from posix::basic_descriptor.]
-
-[indexterm2 native_handle..posix::basic_stream_descriptor]
-Get the native descriptor representation.
-
-
- native_handle_type native_handle();
-
-
-This function may be used to obtain the underlying representation of the descriptor. This is intended to allow access to native descriptor functionality that is not otherwise provided.
-
-
-[endsect]
-
-
-
-[section:native_handle_type posix::basic_stream_descriptor::native_handle_type]
+ [
+ [[link boost_asio.reference.raw_socket_service.move_assign [*move_assign]]]
+ [Move-assign from another raw socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.move_construct [*move_construct]]]
+ [Move-construct a new raw socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.native_handle [*native_handle]]]
+ [Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
-[indexterm2 native_handle_type..posix::basic_stream_descriptor]
-The native representation of a descriptor.
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.open [*open]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.raw_socket_service [*raw_socket_service]]]
+ [Construct a new raw socket service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.receive [*receive]]]
+ [Receive some data from the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.receive_from [*receive_from]]]
+ [Receive raw data with the endpoint of the sender. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.send [*send]]]
+ [Send the given data to the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.send_to [*send_to]]]
+ [Send raw data to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.set_option [*set_option]]]
+ [Set a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.raw_socket_service.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+]
- typedef StreamDescriptorService::native_handle_type native_handle_type;
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.raw_socket_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+]
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+[*Header: ][^boost/asio/raw_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[endsect]
-
-
-[section:native_non_blocking posix::basic_stream_descriptor::native_non_blocking]
-
-[indexterm2 native_non_blocking..posix::basic_stream_descriptor]
-Gets the non-blocking mode of the native descriptor implementation.
-
-
- bool ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1 native_non_blocking]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload1 more...]]``
-
-
-Sets the non-blocking mode of the native descriptor implementation.
+[section:assign raw_socket_service::assign]
+[indexterm2 assign..raw_socket_service]
+Assign an existing native socket to a raw socket.
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2 native_non_blocking]``(
- bool mode);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload2 more...]]``
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload3 native_non_blocking]``(
- bool mode,
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ const native_handle_type & native_socket,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking.overload3 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::native_non_blocking (1 of 3 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
-
-
-Gets the non-blocking mode of the native descriptor implementation.
- bool native_non_blocking() const;
+[endsect]
-This function is used to retrieve the non-blocking mode of the underlying native descriptor. This mode has no effect on the behaviour of the descriptor object's synchronous operations.
-[heading Return Value]
-
-`true` if the underlying descriptor is in non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).
+[section:async_connect raw_socket_service::async_connect]
+[indexterm2 async_connect..raw_socket_service]
+Start an asynchronous connect.
-[heading Remarks]
-
-The current non-blocking mode is cached by the descriptor object. Consequently, the return value may be incorrect if the non-blocking mode was set directly on the native descriptor.
+ template<
+ typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
+ void async_connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ ConnectHandler handler);
@@ -71333,41 +74834,42 @@
-[section:overload2 posix::basic_stream_descriptor::native_non_blocking (2 of 3 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
-
-
-Sets the non-blocking mode of the native descriptor implementation.
-
+[section:async_receive raw_socket_service::async_receive]
- void native_non_blocking(
- bool mode);
+[indexterm2 async_receive..raw_socket_service]
+Start an asynchronous receive.
-This function is used to modify the non-blocking mode of the underlying native descriptor. It has no effect on the behaviour of the descriptor object's synchronous operations.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ ReadHandler handler);
-[heading Parameters]
-
-[variablelist
-
-[[mode][If `true`, the underlying descriptor is put into non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).]]
+[endsect]
-]
-[heading Exceptions]
-
+[section:async_receive_from raw_socket_service::async_receive_from]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. If the `mode` is `false`, but the current value of `non_blocking()` is `true`, this function fails with `boost::asio::error::invalid_argument`, as the combination does not make sense. ]]
+[indexterm2 async_receive_from..raw_socket_service]
+Start an asynchronous receive that will get the endpoint of the sender.
-]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive_from(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ endpoint_type & sender_endpoint,
+ socket_base::message_flags flags,
+ ReadHandler handler);
@@ -71375,153 +74877,153 @@
-[section:overload3 posix::basic_stream_descriptor::native_non_blocking (3 of 3 overloads)]
-
-
-['Inherited from posix::basic_descriptor.]
+[section:async_send raw_socket_service::async_send]
+[indexterm2 async_send..raw_socket_service]
+Start an asynchronous send.
-Sets the non-blocking mode of the native descriptor implementation.
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ WriteHandler handler);
- boost::system::error_code native_non_blocking(
- bool mode,
- boost::system::error_code & ec);
-This function is used to modify the non-blocking mode of the underlying native descriptor. It has no effect on the behaviour of the descriptor object's synchronous operations.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[mode][If `true`, the underlying descriptor is put into non-blocking mode and direct system calls may fail with `boost::asio::error::would_block` (or the equivalent system error).]]
+[section:async_send_to raw_socket_service::async_send_to]
-[[ec][Set to indicate what error occurred, if any. If the `mode` is `false`, but the current value of `non_blocking()` is `true`, this function fails with `boost::asio::error::invalid_argument`, as the combination does not make sense. ]]
+[indexterm2 async_send_to..raw_socket_service]
+Start an asynchronous send.
-]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send_to(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ const endpoint_type & destination,
+ socket_base::message_flags flags,
+ WriteHandler handler);
[endsect]
-[endsect]
-
-[section:native_type posix::basic_stream_descriptor::native_type]
+[section:at_mark raw_socket_service::at_mark]
-[indexterm2 native_type..posix::basic_stream_descriptor]
-(Deprecated: Use native\_handle\_type.) The native representation of a descriptor.
+[indexterm2 at_mark..raw_socket_service]
+Determine whether the socket is at the out-of-band data mark.
- typedef StreamDescriptorService::native_handle_type native_type;
+ bool at_mark(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:available raw_socket_service::available]
-[endsect]
+[indexterm2 available..raw_socket_service]
+Determine the number of bytes available for reading.
-[section:non_blocking posix::basic_stream_descriptor::non_blocking]
+ std::size_t available(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[indexterm2 non_blocking..posix::basic_stream_descriptor]
-Gets the non-blocking mode of the descriptor.
- bool ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1 non_blocking]``() const;
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload1 more...]]``
+[endsect]
-Sets the non-blocking mode of the descriptor.
+[section:bind raw_socket_service::bind]
- void ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2 non_blocking]``(
- bool mode);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload2 more...]]``
+[indexterm2 bind..raw_socket_service]
- boost::system::error_code ``[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3 non_blocking]``(
- bool mode,
+ boost::system::error_code bind(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.non_blocking.overload3 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::non_blocking (1 of 3 overloads)]
-['Inherited from posix::basic_descriptor.]
+[endsect]
-Gets the non-blocking mode of the descriptor.
- bool non_blocking() const;
+[section:cancel raw_socket_service::cancel]
+[indexterm2 cancel..raw_socket_service]
+Cancel all asynchronous operations associated with the socket.
-[heading Return Value]
-
-`true` if the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[heading Remarks]
-
-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`.
+[endsect]
-[endsect]
+[section:close raw_socket_service::close]
+[indexterm2 close..raw_socket_service]
+Close a raw socket implementation.
-[section:overload2 posix::basic_stream_descriptor::non_blocking (2 of 3 overloads)]
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-['Inherited from posix::basic_descriptor.]
+[endsect]
-Sets the non-blocking mode of the descriptor.
- void non_blocking(
- bool mode);
+[section:connect raw_socket_service::connect]
+[indexterm2 connect..raw_socket_service]
+Connect the raw socket to the specified endpoint.
-[heading Parameters]
-
+ boost::system::error_code connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ boost::system::error_code & ec);
-[variablelist
-
-[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
-]
+[endsect]
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[section:construct raw_socket_service::construct]
+[indexterm2 construct..raw_socket_service]
+Construct a new raw socket implementation.
-[heading Remarks]
-
-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 construct(
+ implementation_type & impl);
@@ -71529,195 +75031,156 @@
-[section:overload3 posix::basic_stream_descriptor::non_blocking (3 of 3 overloads)]
-
+[section:destroy raw_socket_service::destroy]
-['Inherited from posix::basic_descriptor.]
+[indexterm2 destroy..raw_socket_service]
+Destroy a raw socket implementation.
-Sets the non-blocking mode of the descriptor.
+ void destroy(
+ implementation_type & impl);
- boost::system::error_code non_blocking(
- bool mode,
- boost::system::error_code & ec);
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[mode][If `true`, the descriptor's synchronous operations will fail with `boost::asio::error::would_block` if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.]]
+[section:endpoint_type raw_socket_service::endpoint_type]
-[[ec][Set to indicate what error occurred, if any.]]
+[indexterm2 endpoint_type..raw_socket_service]
+The endpoint type.
-]
+ typedef Protocol::endpoint endpoint_type;
-[heading Remarks]
-
-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`.
+[heading Requirements]
+[*Header: ][^boost/asio/raw_socket_service.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:non_blocking_io posix::basic_stream_descriptor::non_blocking_io]
-
-['Inherited from posix::descriptor_base.]
+[section:get_io_service raw_socket_service::get_io_service]
-[indexterm2 non_blocking_io..posix::basic_stream_descriptor]
-(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
+['Inherited from io_service.]
- typedef implementation_defined non_blocking_io;
+[indexterm2 get_io_service..raw_socket_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ boost::asio::io_service & get_io_service();
-Implements the FIONBIO IO control command.
-[heading Example]
-
+[endsect]
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::descriptor_base::non_blocking_io command(true);
- descriptor.io_control(command);
+[section:get_option raw_socket_service::get_option]
+[indexterm2 get_option..raw_socket_service]
+Get a socket option.
+ template<
+ typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSocketOption & option,
+ boost::system::error_code & ec) const;
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:id raw_socket_service::id]
-[endsect]
+[indexterm2 id..raw_socket_service]
+The unique service identifier.
+ static boost::asio::io_service::id id;
-[section:operator_eq_ posix::basic_stream_descriptor::operator=]
-[indexterm2 operator=..posix::basic_stream_descriptor]
-Move-assign a [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] from another.
+[endsect]
- basic_stream_descriptor & operator=(
- basic_stream_descriptor && other);
-This assignment operator moves a stream descriptor from one object to another.
+[section:implementation_type raw_socket_service::implementation_type]
+[indexterm2 implementation_type..raw_socket_service]
+The type of a raw socket.
-[heading Parameters]
-
-[variablelist
-
-[[other][The other [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] object from which the move will occur.]]
+ typedef implementation_defined implementation_type;
-]
-[heading Remarks]
-
-Following the move, the moved-from object is in the same state as if constructed using the `basic_stream_descriptor(io_service&) constructor`.
+[heading Requirements]
+[*Header: ][^boost/asio/raw_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:read_some posix::basic_stream_descriptor::read_some]
-[indexterm2 read_some..posix::basic_stream_descriptor]
-Read some data from the descriptor.
+[section:io_control raw_socket_service::io_control]
+[indexterm2 io_control..raw_socket_service]
+Perform an IO control command on the socket.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1 read_some]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload1 more...]]``
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2 read_some]``(
- const MutableBufferSequence & buffers,
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.read_some.overload2 more...]]``
-
-
-[section:overload1 posix::basic_stream_descriptor::read_some (1 of 2 overloads)]
-
-
-Read some data from the descriptor.
-
-
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers);
-
-
-This function is used to read data from the stream descriptor. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
-[heading Parameters]
-
-[variablelist
-
-[[buffers][One or more buffers into which the data will be read.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes read.
+[section:is_open raw_socket_service::is_open]
+[indexterm2 is_open..raw_socket_service]
+Determine whether the socket is open.
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. An error code of `boost::asio::error::eof` indicates that the connection was closed by the peer.]]
+ bool is_open(
+ const implementation_type & impl) const;
-]
-[heading Remarks]
-
-The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+[endsect]
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- descriptor.read_some(boost::asio::buffer(data, size));
+[section:local_endpoint raw_socket_service::local_endpoint]
+[indexterm2 local_endpoint..raw_socket_service]
+Get the local endpoint.
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+ endpoint_type local_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
@@ -71725,90 +75188,62 @@
-[section:overload2 posix::basic_stream_descriptor::read_some (2 of 2 overloads)]
-
-
-Read some data from the descriptor.
-
-
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
-
-
-This function is used to read data from the stream descriptor. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
+[section:move_assign raw_socket_service::move_assign]
+[indexterm2 move_assign..raw_socket_service]
+Move-assign from another raw socket implementation.
-[heading Parameters]
-
-[variablelist
-
-[[buffers][One or more buffers into which the data will be read.]]
+ void move_assign(
+ implementation_type & impl,
+ raw_socket_service & other_service,
+ implementation_type & other_impl);
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes read. Returns 0 if an error occurred.
-[heading Remarks]
-
-The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+[section:move_construct raw_socket_service::move_construct]
+[indexterm2 move_construct..raw_socket_service]
+Move-construct a new raw socket implementation.
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
-[endsect]
[endsect]
-[section:release posix::basic_stream_descriptor::release]
-
-
-['Inherited from posix::basic_descriptor.]
-
-[indexterm2 release..posix::basic_stream_descriptor]
-Release ownership of the native descriptor implementation.
+[section:native raw_socket_service::native]
- native_handle_type release();
+[indexterm2 native..raw_socket_service]
+(Deprecated: Use `native_handle()`.) Get the native socket implementation.
-This function may be used to obtain the underlying representation of the descriptor. After calling this function, `is_open()` returns false. The caller is responsible for closing the descriptor.
+ native_type native(
+ implementation_type & impl);
-All outstanding asynchronous read or write operations will finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
[endsect]
-[section:service posix::basic_stream_descriptor::service]
-
-
-['Inherited from basic_io_object.]
-
-[indexterm2 service..posix::basic_stream_descriptor]
-(Deprecated: Use `get_service()`.) The service associated with the I/O object.
-
-
- service_type & service;
-
+[section:native_handle raw_socket_service::native_handle]
+[indexterm2 native_handle..raw_socket_service]
+Get the native socket implementation.
-[heading Remarks]
-
-Available only for services that do not support movability.
+ native_handle_type native_handle(
+ implementation_type & impl);
@@ -71816,22 +75251,19 @@
-[section:service_type posix::basic_stream_descriptor::service_type]
-
-
-['Inherited from basic_io_object.]
+[section:native_handle_type raw_socket_service::native_handle_type]
-[indexterm2 service_type..posix::basic_stream_descriptor]
-The type of the service that will be used to provide I/O operations.
+[indexterm2 native_handle_type..raw_socket_service]
+The native socket type.
- typedef StreamDescriptorService service_type;
+ typedef implementation_defined native_handle_type;
[heading Requirements]
-[*Header: ][^boost/asio/posix/basic_stream_descriptor.hpp]
+[*Header: ][^boost/asio/raw_socket_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -71839,268 +75271,257 @@
[endsect]
-[section:write_some posix::basic_stream_descriptor::write_some]
+[section:native_non_blocking raw_socket_service::native_non_blocking]
-[indexterm2 write_some..posix::basic_stream_descriptor]
-Write some data to the descriptor.
+[indexterm2 native_non_blocking..raw_socket_service]
+Gets the non-blocking mode of the native socket implementation.
+
+
+ bool ``[link boost_asio.reference.raw_socket_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.raw_socket_service.native_non_blocking.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1 write_some]``(
- const ConstBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload1 more...]]``
+Sets the non-blocking mode of the native socket implementation.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2 write_some]``(
- const ConstBufferSequence & buffers,
+
+ boost::system::error_code ``[link boost_asio.reference.raw_socket_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__basic_stream_descriptor.write_some.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.raw_socket_service.native_non_blocking.overload2 more...]]``
-[section:overload1 posix::basic_stream_descriptor::write_some (1 of 2 overloads)]
+[section:overload1 raw_socket_service::native_non_blocking (1 of 2 overloads)]
-Write some data to the descriptor.
+Gets the non-blocking mode of the native socket implementation.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers);
+ bool native_non_blocking(
+ const implementation_type & impl) const;
-This function is used to write data to the stream descriptor. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[buffers][One or more data buffers to be written to the descriptor.]]
-]
+[section:overload2 raw_socket_service::native_non_blocking (2 of 2 overloads)]
-[heading Return Value]
-
-The number of bytes written.
+Sets the non-blocking mode of the native socket implementation.
-[heading Exceptions]
-
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. An error code of `boost::asio::error::eof` indicates that the connection was closed by the peer.]]
-]
+[endsect]
-[heading Remarks]
-
-The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
+[endsect]
-[heading Example]
-
-To write a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- descriptor.write_some(boost::asio::buffer(data, size));
+[section:native_type raw_socket_service::native_type]
+[indexterm2 native_type..raw_socket_service]
+(Deprecated: Use native\_handle\_type.) The native socket type.
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+ typedef implementation_defined native_type;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/raw_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload2 posix::basic_stream_descriptor::write_some (2 of 2 overloads)]
+[endsect]
-Write some data to the descriptor.
+[section:non_blocking raw_socket_service::non_blocking]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
+[indexterm2 non_blocking..raw_socket_service]
+Gets the non-blocking mode of the socket.
-This function is used to write data to the stream descriptor. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.
+ bool ``[link boost_asio.reference.raw_socket_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.raw_socket_service.non_blocking.overload1 more...]]``
-[heading Parameters]
-
+Sets the non-blocking mode of the socket.
-[variablelist
-
-[[buffers][One or more data buffers to be written to the descriptor.]]
-[[ec][Set to indicate what error occurred, if any.]]
+ boost::system::error_code ``[link boost_asio.reference.raw_socket_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.raw_socket_service.non_blocking.overload2 more...]]``
-]
+[section:overload1 raw_socket_service::non_blocking (1 of 2 overloads)]
-[heading Return Value]
-
-The number of bytes written. Returns 0 if an error occurred.
+Gets the non-blocking mode of the socket.
-[heading Remarks]
-
-The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
+ bool non_blocking(
+ const implementation_type & impl) const;
[endsect]
-[endsect]
+[section:overload2 raw_socket_service::non_blocking (2 of 2 overloads)]
-[endsect]
-[section:posix__descriptor_base posix::descriptor_base]
+Sets the non-blocking mode of the socket.
-The [link boost_asio.reference.posix__descriptor_base `posix::descriptor_base`] class is used as a base for the [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template so that we have a common place to define the associated IO control commands.
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
- class descriptor_base
+[endsect]
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.posix__descriptor_base.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
- [
+[section:open raw_socket_service::open]
- [[link boost_asio.reference.posix__descriptor_base.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
-
- ]
+[indexterm2 open..raw_socket_service]
-]
+ boost::system::error_code open(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ boost::system::error_code & ec);
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.posix__descriptor_base._descriptor_base [*~descriptor_base]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
-]
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/posix/descriptor_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:protocol_type raw_socket_service::protocol_type]
-[section:bytes_readable posix::descriptor_base::bytes_readable]
+[indexterm2 protocol_type..raw_socket_service]
+The protocol type.
-[indexterm2 bytes_readable..posix::descriptor_base]
-IO control command to get the amount of data that can be read without blocking.
+ typedef Protocol protocol_type;
- typedef implementation_defined bytes_readable;
+[heading Requirements]
-Implements the FIONREAD IO control command.
+[*Header: ][^boost/asio/raw_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Example]
-
+[endsect]
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::descriptor_base::bytes_readable command(true);
- descriptor.io_control(command);
- std::size_t bytes_readable = command.get();
+[section:raw_socket_service raw_socket_service::raw_socket_service]
+[indexterm2 raw_socket_service..raw_socket_service]
+Construct a new raw socket service for the specified [link boost_asio.reference.io_service `io_service`].
+ raw_socket_service(
+ boost::asio::io_service & io_service);
-[heading Requirements]
-[*Header: ][^boost/asio/posix/descriptor_base.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:receive raw_socket_service::receive]
+[indexterm2 receive..raw_socket_service]
+Receive some data from the peer.
-[section:non_blocking_io posix::descriptor_base::non_blocking_io]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-[indexterm2 non_blocking_io..posix::descriptor_base]
-(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the descriptor.
- typedef implementation_defined non_blocking_io;
+[endsect]
-Implements the FIONBIO IO control command.
+[section:receive_from raw_socket_service::receive_from]
+[indexterm2 receive_from..raw_socket_service]
+Receive raw data with the endpoint of the sender.
-[heading Example]
-
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive_from(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ endpoint_type & sender_endpoint,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
- boost::asio::posix::stream_descriptor descriptor(io_service);
- ...
- boost::asio::descriptor_base::non_blocking_io command(true);
- descriptor.io_control(command);
+[endsect]
+[section:remote_endpoint raw_socket_service::remote_endpoint]
+[indexterm2 remote_endpoint..raw_socket_service]
+Get the remote endpoint.
-[heading Requirements]
-[*Header: ][^boost/asio/posix/descriptor_base.hpp]
+ endpoint_type remote_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:_descriptor_base posix::descriptor_base::~descriptor_base]
+[section:send raw_socket_service::send]
-[indexterm2 ~descriptor_base..posix::descriptor_base]
-Protected destructor to prevent deletion through this type.
+[indexterm2 send..raw_socket_service]
+Send the given data to the peer.
- ~descriptor_base();
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
@@ -72108,409 +75529,227 @@
-[endsect]
+[section:send_to raw_socket_service::send_to]
+[indexterm2 send_to..raw_socket_service]
+Send raw data to the specified endpoint.
-[section:posix__stream_descriptor posix::stream_descriptor]
-[indexterm1 posix::stream_descriptor]
-Typedef for the typical usage of a stream-oriented descriptor.
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send_to(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ const endpoint_type & destination,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
- typedef basic_stream_descriptor stream_descriptor;
+[endsect]
-[heading Types]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
-
- ]
+[section:set_option raw_socket_service::set_option]
- [
+[indexterm2 set_option..raw_socket_service]
+Set a socket option.
- [[link boost_asio.reference.posix__basic_stream_descriptor.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
-
- ]
- [
+ template<
+ typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSocketOption & option,
+ boost::system::error_code & ec);
- [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer_type [*lowest_layer_type]]]
- [A basic_descriptor is always the lowest layer. ]
-
- ]
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle_type [*native_handle_type]]]
- [The native representation of a descriptor. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a descriptor. ]
-
- ]
- [
+[section:shutdown raw_socket_service::shutdown]
- [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the descriptor. ]
-
- ]
+[indexterm2 shutdown..raw_socket_service]
+Disable sends or receives on the socket.
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
-
- ]
+ boost::system::error_code shutdown(
+ implementation_type & impl,
+ socket_base::shutdown_type what,
+ boost::system::error_code & ec);
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.assign [*assign]]]
- [Assign an existing native descriptor to the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.basic_stream_descriptor [*basic_stream_descriptor]]]
- [Construct a basic_stream_descriptor without opening it.
+[endsect]
- Construct a basic_stream_descriptor on an existing native descriptor.
- Move-construct a basic_stream_descriptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.close [*close]]]
- [Close the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.io_control [*io_control]]]
- [Perform an IO control command on the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.is_open [*is_open]]]
- [Determine whether the descriptor is open. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
- Get a const reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native descriptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_handle [*native_handle]]]
- [Get the native descriptor representation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native descriptor implementation.
+[endsect]
- Sets the non-blocking mode of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the descriptor.
+[section:read read]
- Sets the non-blocking mode of the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.operator_eq_ [*operator=]]]
- [Move-assign a basic_stream_descriptor from another. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.read_some [*read_some]]]
- [Read some data from the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.release [*release]]]
- [Release ownership of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.write_some [*write_some]]]
- [Write some data to the descriptor. ]
- ]
-
-]
+[indexterm1 read]
+Attempt to read a certain amount of data from a stream before returning.
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.read.overload1 read]``(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.read.overload1 more...]]``
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.read.overload2 read]``(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read.overload2 more...]]``
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read.overload3 read]``(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition);
+ `` [''''»''' [link boost_asio.reference.read.overload3 more...]]``
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read.overload4 read]``(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read.overload4 more...]]``
- [
- [[link boost_asio.reference.posix__basic_stream_descriptor.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read.overload5 read]``(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b);
+ `` [''''»''' [link boost_asio.reference.read.overload5 more...]]``
-]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read.overload6 read]``(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read.overload6 more...]]``
-The [link boost_asio.reference.posix__basic_stream_descriptor `posix::basic_stream_descriptor`] class template provides asynchronous and blocking stream-oriented descriptor functionality.
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read.overload7 read]``(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition);
+ `` [''''»''' [link boost_asio.reference.read.overload7 more...]]``
+
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read.overload8 read]``(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read.overload8 more...]]``
+[heading Requirements]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[*Header: ][^boost/asio/read.hpp]
-[*Shared] [*objects:] Unsafe.
+[*Convenience header: ][^boost/asio.hpp]
+[section:overload1 read (1 of 8 overloads)]
+Attempt to read a certain amount of data from a stream before returning.
-[heading Requirements]
-[*Header: ][^boost/asio/posix/stream_descriptor.hpp]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers);
-[*Convenience header: ][^boost/asio.hpp]
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[endsect]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[section:posix__stream_descriptor_service posix::stream_descriptor_service]
+* An error occurred.
-Default service implementation for a stream descriptor.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
- class stream_descriptor_service :
- public io_service::service
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[heading Types]
-[table
- [[Name][Description]]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
- [
+]
- [[link boost_asio.reference.posix__stream_descriptor_service.implementation_type [*implementation_type]]]
- [The type of a stream descriptor implementation. ]
-
- ]
- [
+[heading Return Value]
+
+The number of bytes transferred.
- [[link boost_asio.reference.posix__stream_descriptor_service.native_handle_type [*native_handle_type]]]
- [The native descriptor type. ]
-
- ]
- [
+[heading Exceptions]
+
- [[link boost_asio.reference.posix__stream_descriptor_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native descriptor type. ]
+[variablelist
- ]
+[[boost::system::system_error][Thrown on failure.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.assign [*assign]]]
- [Assign an existing native descriptor to a stream descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.close [*close]]]
- [Close a stream descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.construct [*construct]]]
- [Construct a new stream descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.destroy [*destroy]]]
- [Destroy a stream descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.io_control [*io_control]]]
- [Perform an IO control command on the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.is_open [*is_open]]]
- [Determine whether the descriptor is open. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.move_assign [*move_assign]]]
- [Move-assign from another stream descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.move_construct [*move_construct]]]
- [Move-construct a new stream descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.native_handle [*native_handle]]]
- [Get the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native descriptor implementation.
-
- Sets the non-blocking mode of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the descriptor.
- Sets the non-blocking mode of the descriptor. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.read_some [*read_some]]]
- [Read some data from the stream. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.release [*release]]]
- [Release ownership of the native descriptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.stream_descriptor_service [*stream_descriptor_service]]]
- [Construct a new stream descriptor service for the specified io_service. ]
- ]
-
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.write_some [*write_some]]]
- [Write the given data to the stream. ]
- ]
+[heading Example]
-]
-
-[heading Data Members]
-[table
- [[Name][Description]]
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- [
- [[link boost_asio.reference.posix__stream_descriptor_service.id [*id]]]
- [The unique service identifier. ]
- ]
+ boost::asio::read(s, boost::asio::buffer(data, size));
-]
-[heading Requirements]
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Remarks]
+
+This overload is equivalent to calling:
+ boost::asio::read(
+ s, buffers,
+ boost::asio::transfer_all());
-[section:assign posix::stream_descriptor_service::assign]
-[indexterm2 assign..posix::stream_descriptor_service]
-Assign an existing native descriptor to a stream descriptor.
- boost::system::error_code assign(
- implementation_type & impl,
- const native_handle_type & native_descriptor,
- boost::system::error_code & ec);
@@ -72518,71 +75757,72 @@
-[section:async_read_some posix::stream_descriptor_service::async_read_some]
+[section:overload2 read (2 of 8 overloads)]
-[indexterm2 async_read_some..posix::stream_descriptor_service]
-Start an asynchronous read.
+
+Attempt to read a certain amount of data from a stream before returning.
template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- implementation_type & impl,
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read(
+ SyncReadStream & s,
const MutableBufferSequence & buffers,
- ReadHandler handler);
+ boost::system::error_code & ec);
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[endsect]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[section:async_write_some posix::stream_descriptor_service::async_write_some]
+* An error occurred.
-[indexterm2 async_write_some..posix::stream_descriptor_service]
-Start an asynchronous write.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- WriteHandler handler);
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
-[endsect]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[section:cancel posix::stream_descriptor_service::cancel]
+[heading Return Value]
+
+The number of bytes transferred.
-[indexterm2 cancel..posix::stream_descriptor_service]
-Cancel all asynchronous operations associated with the descriptor.
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+ boost::asio::read(s, boost::asio::buffer(data, size), ec);
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-[endsect]
+[heading Remarks]
+
+This overload is equivalent to calling:
+ boost::asio::read(
+ s, buffers,
+ boost::asio::transfer_all(), ec);
-[section:close posix::stream_descriptor_service::close]
-[indexterm2 close..posix::stream_descriptor_service]
-Close a stream descriptor implementation.
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
@@ -72590,326 +75830,417 @@
-[section:construct posix::stream_descriptor_service::construct]
+[section:overload3 read (3 of 8 overloads)]
-[indexterm2 construct..posix::stream_descriptor_service]
-Construct a new stream descriptor implementation.
+Attempt to read a certain amount of data from a stream before returning.
- void construct(
- implementation_type & impl);
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t read(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition);
-[endsect]
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[section:destroy posix::stream_descriptor_service::destroy]
-[indexterm2 destroy..posix::stream_descriptor_service]
-Destroy a stream descriptor implementation.
+* The completion\_condition function object returns 0.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
- void destroy(
- implementation_type & impl);
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[endsect]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
-[section:get_io_service posix::stream_descriptor_service::get_io_service]
+]
-['Inherited from io_service.]
+[heading Return Value]
+
+The number of bytes transferred.
-[indexterm2 get_io_service..posix::stream_descriptor_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[heading Exceptions]
+
- boost::asio::io_service & get_io_service();
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[endsect]
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+ boost::asio::read(s, boost::asio::buffer(data, size),
+ boost::asio::transfer_at_least(32));
-[section:id posix::stream_descriptor_service::id]
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-[indexterm2 id..posix::stream_descriptor_service]
-The unique service identifier.
- static boost::asio::io_service::id id;
+[endsect]
-[endsect]
+[section:overload4 read (4 of 8 overloads)]
-[section:implementation_type posix::stream_descriptor_service::implementation_type]
+Attempt to read a certain amount of data from a stream before returning.
-[indexterm2 implementation_type..posix::stream_descriptor_service]
-The type of a stream descriptor implementation.
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t read(
+ SyncReadStream & s,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
- typedef implementation_defined implementation_type;
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[heading Requirements]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+* The completion\_condition function object returns 0.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[section:io_control posix::stream_descriptor_service::io_control]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
-[indexterm2 io_control..posix::stream_descriptor_service]
-Perform an IO control command on the descriptor.
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- implementation_type & impl,
- IoControlCommand & command,
- boost::system::error_code & ec);
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
-[section:is_open posix::stream_descriptor_service::is_open]
-[indexterm2 is_open..posix::stream_descriptor_service]
-Determine whether the descriptor is open.
+[endsect]
- bool is_open(
- const implementation_type & impl) const;
+[section:overload5 read (5 of 8 overloads)]
-[endsect]
+Attempt to read a certain amount of data from a stream before returning.
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b);
-[section:move_assign posix::stream_descriptor_service::move_assign]
-[indexterm2 move_assign..posix::stream_descriptor_service]
-Move-assign from another stream descriptor implementation.
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
- void move_assign(
- implementation_type & impl,
- stream_descriptor_service & other_service,
- implementation_type & other_impl);
+* The supplied buffer is full (that is, it has reached maximum size).
+* An error occurred.
-[endsect]
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+[heading Parameters]
+
-[section:move_construct posix::stream_descriptor_service::move_construct]
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[indexterm2 move_construct..posix::stream_descriptor_service]
-Move-construct a new stream descriptor implementation.
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+]
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+[heading Return Value]
+
+The number of bytes transferred.
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[section:native posix::stream_descriptor_service::native]
-[indexterm2 native..posix::stream_descriptor_service]
-(Deprecated: Use `native_handle()`.) Get the native descriptor implementation.
+[heading Remarks]
+
+This overload is equivalent to calling:
+ boost::asio::read(
+ s, b,
+ boost::asio::transfer_all());
- native_type native(
- implementation_type & impl);
-[endsect]
-[section:native_handle posix::stream_descriptor_service::native_handle]
+[endsect]
-[indexterm2 native_handle..posix::stream_descriptor_service]
-Get the native descriptor implementation.
- native_handle_type native_handle(
- implementation_type & impl);
+[section:overload6 read (6 of 8 overloads)]
+Attempt to read a certain amount of data from a stream before returning.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ boost::system::error_code & ec);
-[section:native_handle_type posix::stream_descriptor_service::native_handle_type]
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[indexterm2 native_handle_type..posix::stream_descriptor_service]
-The native descriptor type.
+* The supplied buffer is full (that is, it has reached maximum size).
- typedef implementation_defined native_handle_type;
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
-[heading Requirements]
-[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
+[heading Parameters]
+
-[*Convenience header: ][^boost/asio.hpp]
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[[ec][Set to indicate what error occurred, if any.]]
-[endsect]
+]
-[section:native_non_blocking posix::stream_descriptor_service::native_non_blocking]
+[heading Return Value]
+
+The number of bytes transferred.
-[indexterm2 native_non_blocking..posix::stream_descriptor_service]
-Gets the non-blocking mode of the native descriptor implementation.
+[heading Remarks]
+
+This overload is equivalent to calling:
- bool ``[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload1 more...]]``
+ boost::asio::read(
+ s, b,
+ boost::asio::transfer_all(), ec);
-Sets the non-blocking mode of the native descriptor implementation.
- boost::system::error_code ``[link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.native_non_blocking.overload2 more...]]``
-[section:overload1 posix::stream_descriptor_service::native_non_blocking (1 of 2 overloads)]
+[endsect]
-Gets the non-blocking mode of the native descriptor implementation.
- bool native_non_blocking(
- const implementation_type & impl) const;
+[section:overload7 read (7 of 8 overloads)]
+
+Attempt to read a certain amount of data from a stream before returning.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t read(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition);
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[section:overload2 posix::stream_descriptor_service::native_non_blocking (2 of 2 overloads)]
+* The supplied buffer is full (that is, it has reached maximum size).
-Sets the non-blocking mode of the native descriptor implementation.
+* The completion\_condition function object returns 0.
- boost::system::error_code native_non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+[heading Parameters]
+
-[endsect]
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[endsect]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
-[section:native_type posix::stream_descriptor_service::native_type]
+]
-[indexterm2 native_type..posix::stream_descriptor_service]
-(Deprecated: Use native\_handle\_type.) The native descriptor type.
+[heading Return Value]
+
+The number of bytes transferred.
- typedef implementation_defined native_type;
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/posix/stream_descriptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:non_blocking posix::stream_descriptor_service::non_blocking]
-[indexterm2 non_blocking..posix::stream_descriptor_service]
-Gets the non-blocking mode of the descriptor.
+[section:overload8 read (8 of 8 overloads)]
- bool ``[link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload1 more...]]``
+Attempt to read a certain amount of data from a stream before returning.
-Sets the non-blocking mode of the descriptor.
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t read(
+ SyncReadStream & s,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
- boost::system::error_code ``[link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload2 non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.posix__stream_descriptor_service.non_blocking.overload2 more...]]``
+This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
-[section:overload1 posix::stream_descriptor_service::non_blocking (1 of 2 overloads)]
+* The supplied buffer is full (that is, it has reached maximum size).
-Gets the non-blocking mode of the descriptor.
+* The completion\_condition function object returns 0.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function.
- bool non_blocking(
- const implementation_type & impl) const;
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[endsect]
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
-[section:overload2 posix::stream_descriptor_service::non_blocking (2 of 2 overloads)]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-Sets the non-blocking mode of the descriptor.
+[heading Return Value]
+
+The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
- boost::system::error_code non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
@@ -72918,379 +76249,256 @@
[endsect]
+[section:read_at read_at]
-[section:read_some posix::stream_descriptor_service::read_some]
-
-[indexterm2 read_some..posix::stream_descriptor_service]
-Read some data from the stream.
+[indexterm1 read_at]
+Attempt to read a certain amount of data at the specified offset before returning.
+
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.read_at.overload1 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.read_at.overload1 more...]]``
template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- implementation_type & impl,
+ std::size_t ``[link boost_asio.reference.read_at.overload2 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
const MutableBufferSequence & buffers,
boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_at.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read_at.overload3 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition);
+ `` [''''»''' [link boost_asio.reference.read_at.overload3 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read_at.overload4 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_at.overload4 more...]]``
-[endsect]
-
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_at.overload5 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b);
+ `` [''''»''' [link boost_asio.reference.read_at.overload5 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_at.overload6 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_at.overload6 more...]]``
-[section:release posix::stream_descriptor_service::release]
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read_at.overload7 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition);
+ `` [''''»''' [link boost_asio.reference.read_at.overload7 more...]]``
-[indexterm2 release..posix::stream_descriptor_service]
-Release ownership of the native descriptor implementation.
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t ``[link boost_asio.reference.read_at.overload8 read_at]``(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_at.overload8 more...]]``
+[heading Requirements]
- native_handle_type release(
- implementation_type & impl);
+[*Header: ][^boost/asio/read_at.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:overload1 read_at (1 of 8 overloads)]
+Attempt to read a certain amount of data at the specified offset before returning.
-[section:stream_descriptor_service posix::stream_descriptor_service::stream_descriptor_service]
-[indexterm2 stream_descriptor_service..posix::stream_descriptor_service]
-Construct a new stream descriptor service for the specified [link boost_asio.reference.io_service `io_service`].
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers);
- stream_descriptor_service(
- boost::asio::io_service & io_service);
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[endsect]
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
-[section:write_some posix::stream_descriptor_service::write_some]
-[indexterm2 write_some..posix::stream_descriptor_service]
-Write the given data to the stream.
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
+[[offset][The offset at which the data will be read.]]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes transferred.
-[endsect]
+[heading Exceptions]
+
-[section:raw_socket_service raw_socket_service]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-Default service implementation for a raw socket.
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class raw_socket_service :
- public io_service::service
+ boost::asio::read_at(d, 42, boost::asio::buffer(data, size));
-[heading Types]
-[table
- [[Name][Description]]
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
- [
- [[link boost_asio.reference.raw_socket_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
+[heading Remarks]
+
+This overload is equivalent to calling:
- [
+ boost::asio::read_at(
+ d, 42, buffers,
+ boost::asio::transfer_all());
- [[link boost_asio.reference.raw_socket_service.implementation_type [*implementation_type]]]
- [The type of a raw socket. ]
-
- ]
- [
- [[link boost_asio.reference.raw_socket_service.native_handle_type [*native_handle_type]]]
- [The native socket type. ]
-
- ]
- [
- [[link boost_asio.reference.raw_socket_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native socket type. ]
-
- ]
- [
- [[link boost_asio.reference.raw_socket_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
-
- ]
+[endsect]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.raw_socket_service.assign [*assign]]]
- [Assign an existing native socket to a raw socket. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.async_receive [*async_receive]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.async_receive_from [*async_receive_from]]]
- [Start an asynchronous receive that will get the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.async_send [*async_send]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.async_send_to [*async_send_to]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.bind [*bind]]]
- []
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.close [*close]]]
- [Close a raw socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.connect [*connect]]]
- [Connect the raw socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.construct [*construct]]]
- [Construct a new raw socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.destroy [*destroy]]]
- [Destroy a raw socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.get_option [*get_option]]]
- [Get a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.local_endpoint [*local_endpoint]]]
- [Get the local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.move_assign [*move_assign]]]
- [Move-assign from another raw socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.move_construct [*move_construct]]]
- [Move-construct a new raw socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.native_handle [*native_handle]]]
- [Get the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
+[section:overload2 read_at (2 of 8 overloads)]
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.open [*open]]]
- []
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.raw_socket_service [*raw_socket_service]]]
- [Construct a new raw socket service for the specified io_service. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.receive [*receive]]]
- [Receive some data from the peer. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.receive_from [*receive_from]]]
- [Receive raw data with the endpoint of the sender. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.send [*send]]]
- [Send the given data to the peer. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.send_to [*send_to]]]
- [Send raw data to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.set_option [*set_option]]]
- [Set a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.raw_socket_service.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
- ]
-
-]
+Attempt to read a certain amount of data at the specified offset before returning.
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.raw_socket_service.id [*id]]]
- [The unique service identifier. ]
- ]
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
-]
-[heading Requirements]
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[*Header: ][^boost/asio/raw_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[section:assign raw_socket_service::assign]
+* An error occurred.
-[indexterm2 assign..raw_socket_service]
-Assign an existing native socket to a raw socket.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
- boost::system::error_code assign(
- implementation_type & impl,
- const protocol_type & protocol,
- const native_handle_type & native_socket,
- boost::system::error_code & ec);
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[[offset][The offset at which the data will be read.]]
-[endsect]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[section:async_connect raw_socket_service::async_connect]
-[indexterm2 async_connect..raw_socket_service]
-Start an asynchronous connect.
+[heading Return Value]
+
+The number of bytes transferred.
- template<
- typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
- void async_connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- ConnectHandler handler);
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+ boost::asio::read_at(d, 42,
+ boost::asio::buffer(data, size), ec);
-[endsect]
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+[heading Remarks]
+
+This overload is equivalent to calling:
+
+ boost::asio::read_at(
+ d, 42, buffers,
+ boost::asio::transfer_all(), ec);
-[section:async_receive raw_socket_service::async_receive]
-[indexterm2 async_receive..raw_socket_service]
-Start an asynchronous receive.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- ReadHandler handler);
@@ -73298,80 +76506,85 @@
-[section:async_receive_from raw_socket_service::async_receive_from]
+[section:overload3 read_at (3 of 8 overloads)]
-[indexterm2 async_receive_from..raw_socket_service]
-Start an asynchronous receive that will get the endpoint of the sender.
+
+Attempt to read a certain amount of data at the specified offset before returning.
template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive_from(
- implementation_type & impl,
+ typename CompletionCondition>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
const MutableBufferSequence & buffers,
- endpoint_type & sender_endpoint,
- socket_base::message_flags flags,
- ReadHandler handler);
+ CompletionCondition completion_condition);
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[endsect]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[section:async_send raw_socket_service::async_send]
+* The completion\_condition function object returns 0.
-[indexterm2 async_send..raw_socket_service]
-Start an asynchronous send.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- WriteHandler handler);
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[[offset][The offset at which the data will be read.]]
-[endsect]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some_at operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
-[section:async_send_to raw_socket_service::async_send_to]
+]
-[indexterm2 async_send_to..raw_socket_service]
-Start an asynchronous send.
+[heading Return Value]
+
+The number of bytes transferred.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send_to(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- const endpoint_type & destination,
- socket_base::message_flags flags,
- WriteHandler handler);
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[endsect]
+]
+[heading Example]
+
+To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
-[section:at_mark raw_socket_service::at_mark]
+ boost::asio::read_at(d, 42, boost::asio::buffer(data, size),
+ boost::asio::transfer_at_least(32));
-[indexterm2 at_mark..raw_socket_service]
-Determine whether the socket is at the out-of-band data mark.
+See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
- bool at_mark(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
@@ -73379,166 +76592,200 @@
-[section:available raw_socket_service::available]
-
-[indexterm2 available..raw_socket_service]
-Determine the number of bytes available for reading.
+[section:overload4 read_at (4 of 8 overloads)]
- std::size_t available(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+Attempt to read a certain amount of data at the specified offset before returning.
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename CompletionCondition>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ const MutableBufferSequence & buffers,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
-[endsect]
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[section:bind raw_socket_service::bind]
+* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-[indexterm2 bind..raw_socket_service]
- boost::system::error_code bind(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
+* The completion\_condition function object returns 0.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[[offset][The offset at which the data will be read.]]
-[section:cancel raw_socket_service::cancel]
+[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
-[indexterm2 cancel..raw_socket_service]
-Cancel all asynchronous operations associated with the socket.
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some_at operation.
+ const boost::system::error_code& error,
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
-[section:close raw_socket_service::close]
-[indexterm2 close..raw_socket_service]
-Close a raw socket implementation.
+[endsect]
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
+[section:overload5 read_at (5 of 8 overloads)]
-[endsect]
+Attempt to read a certain amount of data at the specified offset before returning.
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b);
-[section:connect raw_socket_service::connect]
-[indexterm2 connect..raw_socket_service]
-Connect the raw socket to the specified endpoint.
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
- boost::system::error_code connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- boost::system::error_code & ec);
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[[offset][The offset at which the data will be read.]]
-[section:construct raw_socket_service::construct]
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[indexterm2 construct..raw_socket_service]
-Construct a new raw socket implementation.
+]
- void construct(
- implementation_type & impl);
+[heading Return Value]
+
+The number of bytes transferred.
+[heading Exceptions]
+
-[endsect]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[section:destroy raw_socket_service::destroy]
+[heading Remarks]
+
+This overload is equivalent to calling:
-[indexterm2 destroy..raw_socket_service]
-Destroy a raw socket implementation.
+ boost::asio::read_at(
+ d, 42, b,
+ boost::asio::transfer_all());
- void destroy(
- implementation_type & impl);
-[endsect]
+[endsect]
-[section:endpoint_type raw_socket_service::endpoint_type]
-[indexterm2 endpoint_type..raw_socket_service]
-The endpoint type.
+[section:overload6 read_at (6 of 8 overloads)]
- typedef Protocol::endpoint endpoint_type;
+Attempt to read a certain amount of data at the specified offset before returning.
-[heading Requirements]
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ boost::system::error_code & ec);
-[*Header: ][^boost/asio/raw_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[endsect]
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
-[section:get_io_service raw_socket_service::get_io_service]
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-['Inherited from io_service.]
+[[offset][The offset at which the data will be read.]]
-[indexterm2 get_io_service..raw_socket_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[[ec][Set to indicate what error occurred, if any.]]
- boost::asio::io_service & get_io_service();
+]
+[heading Return Value]
+
+The number of bytes transferred.
-[endsect]
+[heading Remarks]
+
+This overload is equivalent to calling:
+ boost::asio::read_at(
+ d, 42, b,
+ boost::asio::transfer_all(), ec);
-[section:get_option raw_socket_service::get_option]
-[indexterm2 get_option..raw_socket_service]
-Get a socket option.
- template<
- typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSocketOption & option,
- boost::system::error_code & ec) const;
@@ -73546,53 +76793,71 @@
-[section:id raw_socket_service::id]
-
-[indexterm2 id..raw_socket_service]
-The unique service identifier.
+[section:overload7 read_at (7 of 8 overloads)]
- static boost::asio::io_service::id id;
+Attempt to read a certain amount of data at the specified offset before returning.
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition);
-[endsect]
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[section:implementation_type raw_socket_service::implementation_type]
+* The completion\_condition function object returns 0.
-[indexterm2 implementation_type..raw_socket_service]
-The type of a raw socket.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
- typedef implementation_defined implementation_type;
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[[offset][The offset at which the data will be read.]]
-[heading Requirements]
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[*Header: ][^boost/asio/raw_socket_service.hpp]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some_at operation.
+ const boost::system::error_code& error,
-[*Convenience header: ][^boost/asio.hpp]
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
+]
-[endsect]
+[heading Return Value]
+
+The number of bytes transferred.
-[section:io_control raw_socket_service::io_control]
+[heading Exceptions]
+
-[indexterm2 io_control..raw_socket_service]
-Perform an IO control command on the socket.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- implementation_type & impl,
- IoControlCommand & command,
- boost::system::error_code & ec);
@@ -73600,149 +76865,253 @@
-[section:is_open raw_socket_service::is_open]
+[section:overload8 read_at (8 of 8 overloads)]
-[indexterm2 is_open..raw_socket_service]
-Determine whether the socket is open.
+Attempt to read a certain amount of data at the specified offset before returning.
- bool is_open(
- const implementation_type & impl) const;
+
+ template<
+ typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
+ typename Allocator,
+ typename CompletionCondition>
+ std::size_t read_at(
+ SyncRandomAccessReadDevice & d,
+ boost::uint64_t offset,
+ basic_streambuf< Allocator > & b,
+ CompletionCondition completion_condition,
+ boost::system::error_code & ec);
+This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-[endsect]
+* The completion\_condition function object returns 0.
+This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
-[section:local_endpoint raw_socket_service::local_endpoint]
-[indexterm2 local_endpoint..raw_socket_service]
-Get the local endpoint.
+[heading Parameters]
+
+[variablelist
+
+[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
- endpoint_type local_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+[[offset][The offset at which the data will be read.]]
+[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+``
+ std::size_t completion_condition(
+ // Result of latest read_some_at operation.
+ const boost::system::error_code& error,
-[endsect]
+ // Number of bytes transferred so far.
+ std::size_t bytes_transferred
+ );
+``
+A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[section:move_assign raw_socket_service::move_assign]
-[indexterm2 move_assign..raw_socket_service]
-Move-assign from another raw socket implementation.
+[heading Return Value]
+
+The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
- void move_assign(
- implementation_type & impl,
- raw_socket_service & other_service,
- implementation_type & other_impl);
+[endsect]
+
[endsect]
+[section:read_until read_until]
+[indexterm1 read_until]
+Read data into a streambuf until it contains a delimiter, matches a regular expression, or a function object indicates a match.
-[section:move_construct raw_socket_service::move_construct]
+
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload1 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ char delim);
+ `` [''''»''' [link boost_asio.reference.read_until.overload1 more...]]``
-[indexterm2 move_construct..raw_socket_service]
-Move-construct a new raw socket implementation.
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload2 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ char delim,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_until.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload3 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const std::string & delim);
+ `` [''''»''' [link boost_asio.reference.read_until.overload3 more...]]``
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload4 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const std::string & delim,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_until.overload4 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload5 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const boost::regex & expr);
+ `` [''''»''' [link boost_asio.reference.read_until.overload5 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t ``[link boost_asio.reference.read_until.overload6 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const boost::regex & expr,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.read_until.overload6 more...]]``
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename MatchCondition>
+ std::size_t ``[link boost_asio.reference.read_until.overload7 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ MatchCondition match_condition,
+ typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
+ `` [''''»''' [link boost_asio.reference.read_until.overload7 more...]]``
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator,
+ typename MatchCondition>
+ std::size_t ``[link boost_asio.reference.read_until.overload8 read_until]``(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ MatchCondition match_condition,
+ boost::system::error_code & ec,
+ typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
+ `` [''''»''' [link boost_asio.reference.read_until.overload8 more...]]``
+[heading Requirements]
-[section:native raw_socket_service::native]
+[*Header: ][^boost/asio/read_until.hpp]
-[indexterm2 native..raw_socket_service]
-(Deprecated: Use `native_handle()`.) Get the native socket implementation.
+[*Convenience header: ][^boost/asio.hpp]
- native_type native(
- implementation_type & impl);
+[section:overload1 read_until (1 of 8 overloads)]
+Read data into a streambuf until it contains a specified delimiter.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read_until(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ char delim);
-[section:native_handle raw_socket_service::native_handle]
+This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
-[indexterm2 native_handle..raw_socket_service]
-Get the native socket implementation.
+* The get area of the streambuf contains the specified delimiter.
- native_handle_type native_handle(
- implementation_type & impl);
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[section:native_handle_type raw_socket_service::native_handle_type]
+[[b][A streambuf object into which the data will be read.]]
-[indexterm2 native_handle_type..raw_socket_service]
-The native socket type.
+[[delim][The delimiter character.]]
+]
- typedef implementation_defined native_handle_type;
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the delimiter.
-[heading Requirements]
+[heading Exceptions]
+
-[*Header: ][^boost/asio/raw_socket_service.hpp]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[*Convenience header: ][^boost/asio.hpp]
+]
-[endsect]
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
-[section:native_non_blocking raw_socket_service::native_non_blocking]
+[heading Example]
+
+To read data into a streambuf until a newline is encountered:
-[indexterm2 native_non_blocking..raw_socket_service]
-Gets the non-blocking mode of the native socket implementation.
+ boost::asio::streambuf b;
+ boost::asio::read_until(s, b, '\n');
+ std::istream is(&b);
+ std::string line;
+ std::getline(is, line);
- bool ``[link boost_asio.reference.raw_socket_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.raw_socket_service.native_non_blocking.overload1 more...]]``
+After the `read_until` operation completes successfully, the buffer `b` contains the delimiter:
+ { 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
-Sets the non-blocking mode of the native socket implementation.
+The call to `std::getline` then extracts the data up to and including the delimiter, so that the string `line` contains:
- boost::system::error_code ``[link boost_asio.reference.raw_socket_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.raw_socket_service.native_non_blocking.overload2 more...]]``
+ { 'a', 'b', ..., 'c', '\n' }
-[section:overload1 raw_socket_service::native_non_blocking (1 of 2 overloads)]
+The remaining data is left in the buffer `b` as follows:
+ { 'd', 'e', ... }
-Gets the non-blocking mode of the native socket implementation.
+This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
- bool native_non_blocking(
- const implementation_type & impl) const;
@@ -73750,399 +77119,339 @@
-[section:overload2 raw_socket_service::native_non_blocking (2 of 2 overloads)]
+[section:overload2 read_until (2 of 8 overloads)]
-Sets the non-blocking mode of the native socket implementation.
+Read data into a streambuf until it contains a specified delimiter.
- boost::system::error_code native_non_blocking(
- implementation_type & impl,
- bool mode,
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read_until(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ char delim,
boost::system::error_code & ec);
+This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
-[endsect]
+* The get area of the streambuf contains the specified delimiter.
-[endsect]
+* An error occurred.
-[section:native_type raw_socket_service::native_type]
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
-[indexterm2 native_type..raw_socket_service]
-(Deprecated: Use native\_handle\_type.) The native socket type.
+[heading Parameters]
+
- typedef implementation_defined native_type;
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[[b][A streambuf object into which the data will be read.]]
+[[delim][The delimiter character.]]
-[heading Requirements]
+[[ec][Set to indicate what error occurred, if any.]]
-[*Header: ][^boost/asio/raw_socket_service.hpp]
+]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the delimiter. Returns 0 if an error occurred.
-[endsect]
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
-[section:non_blocking raw_socket_service::non_blocking]
-[indexterm2 non_blocking..raw_socket_service]
-Gets the non-blocking mode of the socket.
- bool ``[link boost_asio.reference.raw_socket_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.raw_socket_service.non_blocking.overload1 more...]]``
+[endsect]
-Sets the non-blocking mode of the socket.
+[section:overload3 read_until (3 of 8 overloads)]
- boost::system::error_code ``[link boost_asio.reference.raw_socket_service.non_blocking.overload2 non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.raw_socket_service.non_blocking.overload2 more...]]``
+Read data into a streambuf until it contains a specified delimiter.
-[section:overload1 raw_socket_service::non_blocking (1 of 2 overloads)]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read_until(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const std::string & delim);
-Gets the non-blocking mode of the socket.
+This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
- bool non_blocking(
- const implementation_type & impl) const;
+* The get area of the streambuf contains the specified delimiter.
-[endsect]
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
-[section:overload2 raw_socket_service::non_blocking (2 of 2 overloads)]
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-Sets the non-blocking mode of the socket.
+[[b][A streambuf object into which the data will be read.]]
+[[delim][The delimiter string.]]
- boost::system::error_code non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+]
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the delimiter.
-[endsect]
+[heading Exceptions]
+
-[endsect]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[section:open raw_socket_service::open]
-[indexterm2 open..raw_socket_service]
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
- boost::system::error_code open(
- implementation_type & impl,
- const protocol_type & protocol,
- boost::system::error_code & ec);
+[heading Example]
+
+To read data into a streambuf until a newline is encountered:
+
+ boost::asio::streambuf b;
+ boost::asio::read_until(s, b, "\r\n");
+ std::istream is(&b);
+ std::string line;
+ std::getline(is, line);
-[endsect]
+After the `read_until` operation completes successfully, the buffer `b` contains the delimiter:
+ { 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
-[section:protocol_type raw_socket_service::protocol_type]
+The call to `std::getline` then extracts the data up to and including the delimiter, so that the string `line` contains:
-[indexterm2 protocol_type..raw_socket_service]
-The protocol type.
+ { 'a', 'b', ..., 'c', '\r', '\n' }
- typedef Protocol protocol_type;
+The remaining data is left in the buffer `b` as follows:
+ { 'd', 'e', ... }
-[heading Requirements]
+This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
-[*Header: ][^boost/asio/raw_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:raw_socket_service raw_socket_service::raw_socket_service]
+[section:overload4 read_until (4 of 8 overloads)]
-[indexterm2 raw_socket_service..raw_socket_service]
-Construct a new raw socket service for the specified [link boost_asio.reference.io_service `io_service`].
+Read data into a streambuf until it contains a specified delimiter.
- raw_socket_service(
- boost::asio::io_service & io_service);
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read_until(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const std::string & delim,
+ boost::system::error_code & ec);
-[endsect]
+This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
+* The get area of the streambuf contains the specified delimiter.
-[section:receive raw_socket_service::receive]
-[indexterm2 receive..raw_socket_service]
-Receive some data from the peer.
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[endsect]
+[[b][A streambuf object into which the data will be read.]]
+[[delim][The delimiter string.]]
+[[ec][Set to indicate what error occurred, if any.]]
-[section:receive_from raw_socket_service::receive_from]
+]
-[indexterm2 receive_from..raw_socket_service]
-Receive raw data with the endpoint of the sender.
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the delimiter. Returns 0 if an error occurred.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive_from(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- endpoint_type & sender_endpoint,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
-[endsect]
+[endsect]
-[section:remote_endpoint raw_socket_service::remote_endpoint]
-[indexterm2 remote_endpoint..raw_socket_service]
-Get the remote endpoint.
+[section:overload5 read_until (5 of 8 overloads)]
- endpoint_type remote_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+Read data into a streambuf until some part of the data it contains matches a regular expression.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
+ typename Allocator>
+ std::size_t read_until(
+ SyncReadStream & s,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const boost::regex & expr);
+This function is used to read data into the specified streambuf until the streambuf's get area contains some data that matches a regular expression. The call will block until one of the following conditions is true:
-[section:send raw_socket_service::send]
-[indexterm2 send..raw_socket_service]
-Send the given data to the peer.
+* A substring of the streambuf's get area matches the regular expression.
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+* An error occurred.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains data that matches the regular expression, the function returns immediately.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[[b][A streambuf object into which the data will be read.]]
-[section:send_to raw_socket_service::send_to]
+[[expr][The regular expression.]]
-[indexterm2 send_to..raw_socket_service]
-Send raw data to the specified endpoint.
+]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send_to(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- const endpoint_type & destination,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the substring that matches the regular expression.
+[heading Exceptions]
+
-[endsect]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[section:set_option raw_socket_service::set_option]
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the regular expression. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
-[indexterm2 set_option..raw_socket_service]
-Set a socket option.
+[heading Example]
+
+To read data into a streambuf until a CR-LF sequence is encountered:
- template<
- typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
- boost::system::error_code set_option(
- implementation_type & impl,
- const SettableSocketOption & option,
- boost::system::error_code & ec);
+ boost::asio::streambuf b;
+ boost::asio::read_until(s, b, boost::regex("\r\n"));
+ std::istream is(&b);
+ std::string line;
+ std::getline(is, line);
+After the `read_until` operation completes successfully, the buffer `b` contains the data which matched the regular expression:
-[endsect]
+ { 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+The call to `std::getline` then extracts the data up to and including the match, so that the string `line` contains:
-[section:shutdown raw_socket_service::shutdown]
+ { 'a', 'b', ..., 'c', '\r', '\n' }
-[indexterm2 shutdown..raw_socket_service]
-Disable sends or receives on the socket.
+The remaining data is left in the buffer `b` as follows:
- boost::system::error_code shutdown(
- implementation_type & impl,
- socket_base::shutdown_type what,
- boost::system::error_code & ec);
+ { 'd', 'e', ... }
+This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
-[endsect]
[endsect]
-[section:read read]
-
-[indexterm1 read]
-Attempt to read a certain amount of data from a stream before returning.
-
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.read.overload1 read]``(
- SyncReadStream & s,
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.read.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.read.overload2 read]``(
- SyncReadStream & s,
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read.overload2 more...]]``
+[section:overload6 read_until (6 of 8 overloads)]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read.overload3 read]``(
- SyncReadStream & s,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition);
- `` [''''»''' [link boost_asio.reference.read.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read.overload4 read]``(
- SyncReadStream & s,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read.overload4 more...]]``
+Read data into a streambuf until some part of the data it contains matches a regular expression.
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read.overload5 read]``(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b);
- `` [''''»''' [link boost_asio.reference.read.overload5 more...]]``
template<
typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
typename Allocator>
- std::size_t ``[link boost_asio.reference.read.overload6 read]``(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read.overload6 more...]]``
-
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read.overload7 read]``(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition);
- `` [''''»''' [link boost_asio.reference.read.overload7 more...]]``
-
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read.overload8 read]``(
+ std::size_t read_until(
SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition,
+ boost::asio::basic_streambuf< Allocator > & b,
+ const boost::regex & expr,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read.overload8 more...]]``
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/read.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[section:overload1 read (1 of 8 overloads)]
-
-
-Attempt to read a certain amount of data from a stream before returning.
-
-
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read(
- SyncReadStream & s,
- const MutableBufferSequence & buffers);
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+This function is used to read data into the specified streambuf until the streambuf's get area contains some data that matches a regular expression. The call will block until one of the following conditions is true:
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+* A substring of the streambuf's get area matches the regular expression.
* An error occurred.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains data that matches the regular expression, the function returns immediately.
[heading Parameters]
@@ -74152,46 +77461,23 @@
[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
-
-]
-
-
-[heading Return Value]
-
-The number of bytes transferred.
-
+[[b][A streambuf object into which the data will be read.]]
-[heading Exceptions]
-
+[[expr][The regular expression.]]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+[[ec][Set to indicate what error occurred, if any.]]
]
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
-
- boost::asio::read(s, boost::asio::buffer(data, size));
-
-
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
-
-
-[heading Remarks]
-
-This overload is equivalent to calling:
-
- boost::asio::read(
- s, buffers,
- boost::asio::transfer_all());
-
+[heading Return Value]
+
+The number of bytes in the streambuf's get area up to and including the substring that matches the regular expression. Returns 0 if an error occurred.
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the regular expression. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
@@ -74200,30 +77486,32 @@
-[section:overload2 read (2 of 8 overloads)]
+[section:overload7 read_until (7 of 8 overloads)]
-Attempt to read a certain amount of data from a stream before returning.
+Read data into a streambuf until a function object indicates a match.
template<
typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read(
+ typename Allocator,
+ typename MatchCondition>
+ std::size_t read_until(
SyncReadStream & s,
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+ boost::asio::basic_streambuf< Allocator > & b,
+ MatchCondition match_condition,
+ typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+This function is used to read data into the specified streambuf until a user-defined match condition function object, when applied to the data contained in the streambuf, indicates a successful match. The call will block until one of the following conditions is true:
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+* The match condition function object returns a std::pair where the second element evaluates to true.
* An error occurred.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the match condition function object already indicates a match, the function returns immediately.
[heading Parameters]
@@ -74233,37 +77521,95 @@
[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
+[[b][A streambuf object into which the data will be read.]]
-[[ec][Set to indicate what error occurred, if any.]]
+[[match_condition][The function object to be called to determine whether a match exists. The signature of the function object must be:
+``
+ pair<iterator, bool> match_condition(iterator begin, iterator end);
+``
+where `iterator` represents the type:
+``
+ buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
+``
+The iterator parameters `begin` and `end` define the range of bytes to be scanned to determine whether there is a match. The `first` member of the return value is an iterator marking one-past-the-end of the bytes that have been consumed by the match function. This iterator is used to calculate the `begin` parameter for any subsequent invocation of the match condition. The `second` member of the return value is true if a match has been found, false otherwise.]]
]
[heading Return Value]
-The number of bytes transferred.
-
+The number of bytes in the streambuf's get area that have been fully consumed by the match function.
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- boost::asio::read(s, boost::asio::buffer(data, size), ec);
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+]
[heading Remarks]
-This overload is equivalent to calling:
+After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the function object. An application will typically leave that data in the streambuf for a subsequent
- boost::asio::read(
- s, buffers,
- boost::asio::transfer_all(), ec);
+The default implementation of the `is_match_condition` type trait evaluates to true for function pointers and function objects with a `result_type` typedef. It must be specialised for other user-defined function objects.
+
+
+[heading Examples]
+
+To read data into a streambuf until whitespace is encountered:
+
+ typedef boost::asio::buffers_iterator<
+ boost::asio::streambuf::const_buffers_type> iterator;
+
+ std::pair<iterator, bool>
+ match_whitespace(iterator begin, iterator end)
+ {
+ iterator i = begin;
+ while (i != end)
+ if (std::isspace(*i++))
+ return std::make_pair(i, true);
+ return std::make_pair(i, false);
+ }
+ ...
+ boost::asio::streambuf b;
+ boost::asio::read_until(s, b, match_whitespace);
+
+
+
+
+To read data into a streambuf until a matching character is found:
+
+ class match_char
+ {
+ public:
+ explicit match_char(char c) : c_(c) {}
+
+ template <typename Iterator>
+ std::pair<Iterator, bool> operator()(
+ Iterator begin, Iterator end) const
+ {
+ Iterator i = begin;
+ while (i != end)
+ if (c_ == *i++)
+ return std::make_pair(i, true);
+ return std::make_pair(i, false);
+ }
+ private:
+ char c_;
+ };
+ namespace asio {
+ template <> struct is_match_condition<match_char>
+ : public boost::true_type {};
+ } // namespace asio
+ ...
+ boost::asio::streambuf b;
+ boost::asio::read_until(s, b, match_char('a'));
@@ -74273,31 +77619,33 @@
-[section:overload3 read (3 of 8 overloads)]
+[section:overload8 read_until (8 of 8 overloads)]
-Attempt to read a certain amount of data from a stream before returning.
+Read data into a streambuf until a function object indicates a match.
template<
typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t read(
+ typename Allocator,
+ typename MatchCondition>
+ std::size_t read_until(
SyncReadStream & s,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition);
+ boost::asio::basic_streambuf< Allocator > & b,
+ MatchCondition match_condition,
+ boost::system::error_code & ec,
+ typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+This function is used to read data into the specified streambuf until a user-defined match condition function object, when applied to the data contained in the streambuf, indicates a successful match. The call will block until one of the following conditions is true:
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+* The match condition function object returns a std::pair where the second element evaluates to true.
-* The completion\_condition function object returns 0.
+* An error occurred.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the match condition function object already indicates a match, the function returns immediately.
[heading Parameters]
@@ -74307,183 +77655,362 @@
[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
+[[b][A streambuf object into which the data will be read.]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
+[[match_condition][The function object to be called to determine whether a match exists. The signature of the function object must be:
``
- std::size_t completion_condition(
- // Result of latest read_some operation.
- const boost::system::error_code& error,
-
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
+ pair<iterator, bool> match_condition(iterator begin, iterator end);
``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
+where `iterator` represents the type:
+``
+ buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
+``
+The iterator parameters `begin` and `end` define the range of bytes to be scanned to determine whether there is a match. The `first` member of the return value is an iterator marking one-past-the-end of the bytes that have been consumed by the match function. This iterator is used to calculate the `begin` parameter for any subsequent invocation of the match condition. The `second` member of the return value is true if a match has been found, false otherwise.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
]
[heading Return Value]
-The number of bytes transferred.
-
+The number of bytes in the streambuf's get area that have been fully consumed by the match function. Returns 0 if an error occurred.
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+[heading Remarks]
+
+After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the function object. An application will typically leave that data in the streambuf for a subsequent
-]
+The default implementation of the `is_match_condition` type trait evaluates to true for function pointers and function objects with a `result_type` typedef. It must be specialised for other user-defined function objects.
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- boost::asio::read(s, boost::asio::buffer(data, size),
- boost::asio::transfer_at_least(32));
+[endsect]
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+[endsect]
+[section:seq_packet_socket_service seq_packet_socket_service]
-[endsect]
+Default service implementation for a sequenced packet socket.
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class seq_packet_socket_service :
+ public io_service::service
-[section:overload4 read (4 of 8 overloads)]
+[heading Types]
+[table
+ [[Name][Description]]
-Attempt to read a certain amount of data from a stream before returning.
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
+
+ ]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t read(
- SyncReadStream & s,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.implementation_type [*implementation_type]]]
+ [The type of a sequenced packet socket implementation. ]
+
+ ]
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.native_handle_type [*native_handle_type]]]
+ [The native socket type. ]
+
+ ]
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native socket type. ]
+
+ ]
-* The completion\_condition function object returns 0.
+ [
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+ [[link boost_asio.reference.seq_packet_socket_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
+
+ ]
+]
-[heading Parameters]
-
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[variablelist
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.assign [*assign]]]
+ [Assign an existing native socket to a sequenced packet socket. ]
+ ]
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.async_send [*async_send]]]
+ [Start an asynchronous send. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.available [*available]]]
+ [Determine the number of bytes available for reading. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.bind [*bind]]]
+ [Bind the sequenced packet socket to the specified local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.close [*close]]]
+ [Close a sequenced packet socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.connect [*connect]]]
+ [Connect the sequenced packet socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.construct [*construct]]]
+ [Construct a new sequenced packet socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.destroy [*destroy]]]
+ [Destroy a sequenced packet socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.get_option [*get_option]]]
+ [Get a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.move_assign [*move_assign]]]
+ [Move-assign from another sequenced packet socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.move_construct [*move_construct]]]
+ [Move-construct a new sequenced packet socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.native_handle [*native_handle]]]
+ [Get the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the stream.]]
+ Sets the non-blocking mode of the native socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some operation.
- const boost::system::error_code& error,
+ Sets the non-blocking mode of the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.open [*open]]]
+ [Open a sequenced packet socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.receive [*receive]]]
+ [Receive some data from the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.send [*send]]]
+ [Send the given data to the peer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.seq_packet_socket_service [*seq_packet_socket_service]]]
+ [Construct a new sequenced packet socket service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.set_option [*set_option]]]
+ [Set a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+]
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
+[heading Data Members]
+[table
+ [[Name][Description]]
-[[ec][Set to indicate what error occurred, if any.]]
+ [
+ [[link boost_asio.reference.seq_packet_socket_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
]
+[heading Requirements]
-[heading Return Value]
-
-The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
+[section:assign seq_packet_socket_service::assign]
-[endsect]
+[indexterm2 assign..seq_packet_socket_service]
+Assign an existing native socket to a sequenced packet socket.
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ const native_handle_type & native_socket,
+ boost::system::error_code & ec);
-[section:overload5 read (5 of 8 overloads)]
-Attempt to read a certain amount of data from a stream before returning.
+[endsect]
+
+
+
+[section:async_connect seq_packet_socket_service::async_connect]
+
+[indexterm2 async_connect..seq_packet_socket_service]
+Start an asynchronous connect.
template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b);
+ typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
+ void async_connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ ConnectHandler handler);
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+[endsect]
-* The supplied buffer is full (that is, it has reached maximum size).
-* An error occurred.
+[section:async_receive seq_packet_socket_service::async_receive]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+[indexterm2 async_receive..seq_packet_socket_service]
+Start an asynchronous receive.
-[heading Parameters]
-
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags in_flags,
+ socket_base::message_flags & out_flags,
+ ReadHandler handler);
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes transferred.
+[section:async_send seq_packet_socket_service::async_send]
-[heading Exceptions]
-
+[indexterm2 async_send..seq_packet_socket_service]
+Start an asynchronous send.
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ WriteHandler handler);
-[heading Remarks]
-
-This overload is equivalent to calling:
- boost::asio::read(
- s, b,
- boost::asio::transfer_all());
+[endsect]
+
+
+[section:at_mark seq_packet_socket_service::at_mark]
+[indexterm2 at_mark..seq_packet_socket_service]
+Determine whether the socket is at the out-of-band data mark.
+ bool at_mark(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
@@ -74491,62 +78018,64 @@
-[section:overload6 read (6 of 8 overloads)]
+[section:available seq_packet_socket_service::available]
+
+[indexterm2 available..seq_packet_socket_service]
+Determine the number of bytes available for reading.
+
+
+ std::size_t available(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
+
-Attempt to read a certain amount of data from a stream before returning.
+[endsect]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- boost::system::error_code & ec);
+[section:bind seq_packet_socket_service::bind]
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+[indexterm2 bind..seq_packet_socket_service]
+Bind the sequenced packet socket to the specified local endpoint.
-* The supplied buffer is full (that is, it has reached maximum size).
+ boost::system::error_code bind(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
-* An error occurred.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[section:cancel seq_packet_socket_service::cancel]
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[indexterm2 cancel..seq_packet_socket_service]
+Cancel all asynchronous operations associated with the socket.
-[[ec][Set to indicate what error occurred, if any.]]
-]
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[heading Return Value]
-
-The number of bytes transferred.
+[endsect]
-[heading Remarks]
-
-This overload is equivalent to calling:
- boost::asio::read(
- s, b,
- boost::asio::transfer_all(), ec);
+[section:close seq_packet_socket_service::close]
+[indexterm2 close..seq_packet_socket_service]
+Close a sequenced packet socket implementation.
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
@@ -74554,548 +78083,382 @@
-[section:overload7 read (7 of 8 overloads)]
-
+[section:connect seq_packet_socket_service::connect]
-Attempt to read a certain amount of data from a stream before returning.
+[indexterm2 connect..seq_packet_socket_service]
+Connect the sequenced packet socket to the specified endpoint.
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t read(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition);
+ boost::system::error_code connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ boost::system::error_code & ec);
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+[endsect]
-* The supplied buffer is full (that is, it has reached maximum size).
-* The completion\_condition function object returns 0.
+[section:construct seq_packet_socket_service::construct]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+[indexterm2 construct..seq_packet_socket_service]
+Construct a new sequenced packet socket implementation.
-[heading Parameters]
-
+ void construct(
+ implementation_type & impl);
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some operation.
- const boost::system::error_code& error,
+[endsect]
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
-]
+[section:destroy seq_packet_socket_service::destroy]
-[heading Return Value]
-
-The number of bytes transferred.
+[indexterm2 destroy..seq_packet_socket_service]
+Destroy a sequenced packet socket implementation.
-[heading Exceptions]
-
+ void destroy(
+ implementation_type & impl);
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
-]
+[endsect]
-[endsect]
+[section:endpoint_type seq_packet_socket_service::endpoint_type]
+[indexterm2 endpoint_type..seq_packet_socket_service]
+The endpoint type.
-[section:overload8 read (8 of 8 overloads)]
+ typedef Protocol::endpoint endpoint_type;
-Attempt to read a certain amount of data from a stream before returning.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t read(
- SyncReadStream & s,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-This function is used to read a certain number of bytes of data from a stream. The call will block until one of the following conditions is true:
+[endsect]
-* The supplied buffer is full (that is, it has reached maximum size).
-* The completion\_condition function object returns 0.
+[section:get_io_service seq_packet_socket_service::get_io_service]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function.
+['Inherited from io_service.]
-[heading Parameters]
-
+[indexterm2 get_io_service..seq_packet_socket_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+ boost::asio::io_service & get_io_service();
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some operation.
- const boost::system::error_code& error,
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the stream's read\_some function.]]
-[[ec][Set to indicate what error occurred, if any.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
+[section:get_option seq_packet_socket_service::get_option]
+[indexterm2 get_option..seq_packet_socket_service]
+Get a socket option.
+ template<
+ typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSocketOption & option,
+ boost::system::error_code & ec) const;
-[endsect]
[endsect]
-[section:read_at read_at]
-[indexterm1 read_at]
-Attempt to read a certain amount of data at the specified offset before returning.
-
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.read_at.overload1 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.read_at.overload1 more...]]``
+[section:id seq_packet_socket_service::id]
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.read_at.overload2 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_at.overload2 more...]]``
+[indexterm2 id..seq_packet_socket_service]
+The unique service identifier.
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read_at.overload3 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition);
- `` [''''»''' [link boost_asio.reference.read_at.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read_at.overload4 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_at.overload4 more...]]``
+ static boost::asio::io_service::id id;
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_at.overload5 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b);
- `` [''''»''' [link boost_asio.reference.read_at.overload5 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_at.overload6 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_at.overload6 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read_at.overload7 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition);
- `` [''''»''' [link boost_asio.reference.read_at.overload7 more...]]``
+[endsect]
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t ``[link boost_asio.reference.read_at.overload8 read_at]``(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_at.overload8 more...]]``
-[heading Requirements]
-[*Header: ][^boost/asio/read_at.hpp]
+[section:implementation_type seq_packet_socket_service::implementation_type]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 implementation_type..seq_packet_socket_service]
+The type of a sequenced packet socket implementation.
-[section:overload1 read_at (1 of 8 overloads)]
+ typedef implementation_defined implementation_type;
-Attempt to read a certain amount of data at the specified offset before returning.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers);
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[endsect]
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
-* An error occurred.
+[section:io_control seq_packet_socket_service::io_control]
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[indexterm2 io_control..seq_packet_socket_service]
+Perform an IO control command on the socket.
-[heading Parameters]
-
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
+ boost::system::error_code & ec);
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-[[offset][The offset at which the data will be read.]]
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes transferred.
+[section:is_open seq_packet_socket_service::is_open]
+[indexterm2 is_open..seq_packet_socket_service]
+Determine whether the socket is open.
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+ bool is_open(
+ const implementation_type & impl) const;
-]
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+[endsect]
- boost::asio::read_at(d, 42, boost::asio::buffer(data, size));
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+[section:local_endpoint seq_packet_socket_service::local_endpoint]
+[indexterm2 local_endpoint..seq_packet_socket_service]
+Get the local endpoint.
-[heading Remarks]
-
-This overload is equivalent to calling:
- boost::asio::read_at(
- d, 42, buffers,
- boost::asio::transfer_all());
+ endpoint_type local_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
+[endsect]
+[section:move_assign seq_packet_socket_service::move_assign]
-[endsect]
+[indexterm2 move_assign..seq_packet_socket_service]
+Move-assign from another sequenced packet socket implementation.
+ void move_assign(
+ implementation_type & impl,
+ seq_packet_socket_service & other_service,
+ implementation_type & other_impl);
-[section:overload2 read_at (2 of 8 overloads)]
-Attempt to read a certain amount of data at the specified offset before returning.
+[endsect]
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+[section:move_construct seq_packet_socket_service::move_construct]
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[indexterm2 move_construct..seq_packet_socket_service]
+Move-construct a new sequenced packet socket implementation.
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
-* An error occurred.
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[section:native seq_packet_socket_service::native]
-[[offset][The offset at which the data will be read.]]
+[indexterm2 native..seq_packet_socket_service]
+(Deprecated: Use `native_handle()`.) Get the native socket implementation.
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
-[[ec][Set to indicate what error occurred, if any.]]
+ native_type native(
+ implementation_type & impl);
-]
-[heading Return Value]
-
-The number of bytes transferred.
+[endsect]
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
- boost::asio::read_at(d, 42,
- boost::asio::buffer(data, size), ec);
+[section:native_handle seq_packet_socket_service::native_handle]
+[indexterm2 native_handle..seq_packet_socket_service]
+Get the native socket implementation.
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+ native_handle_type native_handle(
+ implementation_type & impl);
-[heading Remarks]
-
-This overload is equivalent to calling:
- boost::asio::read_at(
- d, 42, buffers,
- boost::asio::transfer_all(), ec);
+[endsect]
+[section:native_handle_type seq_packet_socket_service::native_handle_type]
+[indexterm2 native_handle_type..seq_packet_socket_service]
+The native socket type.
-[endsect]
+ typedef implementation_defined native_handle_type;
-[section:overload3 read_at (3 of 8 overloads)]
+[heading Requirements]
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
-Attempt to read a certain amount of data at the specified offset before returning.
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition);
+[endsect]
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[section:native_non_blocking seq_packet_socket_service::native_non_blocking]
+[indexterm2 native_non_blocking..seq_packet_socket_service]
+Gets the non-blocking mode of the native socket implementation.
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+ bool ``[link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload1 more...]]``
-* The completion\_condition function object returns 0.
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+Sets the non-blocking mode of the native socket implementation.
-[heading Parameters]
-
+ boost::system::error_code ``[link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload2 more...]]``
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-[[offset][The offset at which the data will be read.]]
+[section:overload1 seq_packet_socket_service::native_non_blocking (1 of 2 overloads)]
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some_at operation.
- const boost::system::error_code& error,
+Gets the non-blocking mode of the native socket implementation.
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
-]
+ bool native_non_blocking(
+ const implementation_type & impl) const;
-[heading Return Value]
-
-The number of bytes transferred.
+[endsect]
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[section:overload2 seq_packet_socket_service::native_non_blocking (2 of 2 overloads)]
-[heading Example]
-
-To read into a single data buffer use the [link boost_asio.reference.buffer `buffer`] function as follows:
+Sets the non-blocking mode of the native socket implementation.
- boost::asio::read_at(d, 42, boost::asio::buffer(data, size),
- boost::asio::transfer_at_least(32));
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
-See the [link boost_asio.reference.buffer `buffer`] documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.
+[endsect]
[endsect]
+[section:native_type seq_packet_socket_service::native_type]
-[section:overload4 read_at (4 of 8 overloads)]
+[indexterm2 native_type..seq_packet_socket_service]
+(Deprecated: Use native\_handle\_type.) The native socket type.
-Attempt to read a certain amount of data at the specified offset before returning.
+ typedef implementation_defined native_type;
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename CompletionCondition>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- const MutableBufferSequence & buffers,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
+[heading Requirements]
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-* The supplied buffers are full. That is, the bytes transferred is equal to the sum of the buffer sizes.
+[endsect]
-* The completion\_condition function object returns 0.
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[section:non_blocking seq_packet_socket_service::non_blocking]
+
+[indexterm2 non_blocking..seq_packet_socket_service]
+Gets the non-blocking mode of the socket.
-[heading Parameters]
-
+ bool ``[link boost_asio.reference.seq_packet_socket_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.non_blocking.overload1 more...]]``
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-[[offset][The offset at which the data will be read.]]
+Sets the non-blocking mode of the socket.
-[[buffers][One or more buffers into which the data will be read. The sum of the buffer sizes indicates the maximum number of bytes to read from the device.]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some_at operation.
- const boost::system::error_code& error,
+ boost::system::error_code ``[link boost_asio.reference.seq_packet_socket_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.non_blocking.overload2 more...]]``
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
-[[ec][Set to indicate what error occurred, if any.]]
+[section:overload1 seq_packet_socket_service::non_blocking (1 of 2 overloads)]
-]
+Gets the non-blocking mode of the socket.
-[heading Return Value]
-
-The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
+ bool non_blocking(
+ const implementation_type & impl) const;
@@ -75103,458 +78466,516 @@
-[section:overload5 read_at (5 of 8 overloads)]
-
+[section:overload2 seq_packet_socket_service::non_blocking (2 of 2 overloads)]
-Attempt to read a certain amount of data at the specified offset before returning.
+Sets the non-blocking mode of the socket.
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b);
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
-* An error occurred.
+[endsect]
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+[section:open seq_packet_socket_service::open]
-[[offset][The offset at which the data will be read.]]
+[indexterm2 open..seq_packet_socket_service]
+Open a sequenced packet socket.
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-]
+ boost::system::error_code open(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ boost::system::error_code & ec);
-[heading Return Value]
-
-The number of bytes transferred.
+[endsect]
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[section:protocol_type seq_packet_socket_service::protocol_type]
+[indexterm2 protocol_type..seq_packet_socket_service]
+The protocol type.
-[heading Remarks]
-
-This overload is equivalent to calling:
- boost::asio::read_at(
- d, 42, b,
- boost::asio::transfer_all());
+ typedef Protocol protocol_type;
+[heading Requirements]
+[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload6 read_at (6 of 8 overloads)]
-
+[section:receive seq_packet_socket_service::receive]
-Attempt to read a certain amount of data at the specified offset before returning.
+[indexterm2 receive..seq_packet_socket_service]
+Receive some data from the peer.
template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags in_flags,
+ socket_base::message_flags & out_flags,
boost::system::error_code & ec);
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[endsect]
-* An error occurred.
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[section:remote_endpoint seq_packet_socket_service::remote_endpoint]
-[heading Parameters]
-
+[indexterm2 remote_endpoint..seq_packet_socket_service]
+Get the remote endpoint.
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-[[offset][The offset at which the data will be read.]]
+ endpoint_type remote_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[endsect]
-[heading Return Value]
-
-The number of bytes transferred.
+[section:send seq_packet_socket_service::send]
-[heading Remarks]
-
-This overload is equivalent to calling:
+[indexterm2 send..seq_packet_socket_service]
+Send the given data to the peer.
- boost::asio::read_at(
- d, 42, b,
- boost::asio::transfer_all(), ec);
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
+[endsect]
+[section:seq_packet_socket_service seq_packet_socket_service::seq_packet_socket_service]
-[endsect]
+[indexterm2 seq_packet_socket_service..seq_packet_socket_service]
+Construct a new sequenced packet socket service for the specified [link boost_asio.reference.io_service `io_service`].
+ seq_packet_socket_service(
+ boost::asio::io_service & io_service);
+
-[section:overload7 read_at (7 of 8 overloads)]
+[endsect]
-Attempt to read a certain amount of data at the specified offset before returning.
+
+
+[section:set_option seq_packet_socket_service::set_option]
+
+[indexterm2 set_option..seq_packet_socket_service]
+Set a socket option.
template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition);
+ typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSocketOption & option,
+ boost::system::error_code & ec);
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+[endsect]
-* The completion\_condition function object returns 0.
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+[section:shutdown seq_packet_socket_service::shutdown]
-[heading Parameters]
-
+[indexterm2 shutdown..seq_packet_socket_service]
+Disable sends or receives on the socket.
-[variablelist
-
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
-[[offset][The offset at which the data will be read.]]
+ boost::system::error_code shutdown(
+ implementation_type & impl,
+ socket_base::shutdown_type what,
+ boost::system::error_code & ec);
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some_at operation.
- const boost::system::error_code& error,
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes transferred.
+[endsect]
-[heading Exceptions]
-
+[section:serial_port serial_port]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
+[indexterm1 serial_port]
+Typedef for the typical usage of a serial port.
-]
+ typedef basic_serial_port serial_port;
+[heading Types]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_serial_port.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+ [
-[section:overload8 read_at (8 of 8 overloads)]
+ [[link boost_asio.reference.basic_serial_port.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_serial_port is always the lowest layer. ]
+
+ ]
+ [
-Attempt to read a certain amount of data at the specified offset before returning.
+ [[link boost_asio.reference.basic_serial_port.native_handle_type [*native_handle_type]]]
+ [The native representation of a serial port. ]
+
+ ]
+ [
- template<
- typename ``[link boost_asio.reference.SyncRandomAccessReadDevice SyncRandomAccessReadDevice]``,
- typename Allocator,
- typename CompletionCondition>
- std::size_t read_at(
- SyncRandomAccessReadDevice & d,
- boost::uint64_t offset,
- basic_streambuf< Allocator > & b,
- CompletionCondition completion_condition,
- boost::system::error_code & ec);
+ [[link boost_asio.reference.basic_serial_port.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a serial port. ]
+
+ ]
+ [
-This function is used to read a certain number of bytes of data from a random access device at the specified offset. The call will block until one of the following conditions is true:
+ [[link boost_asio.reference.basic_serial_port.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+]
-* The completion\_condition function object returns 0.
+[heading Member Functions]
+[table
+ [[Name][Description]]
-This operation is implemented in terms of zero or more calls to the device's read\_some\_at function.
+ [
+ [[link boost_asio.reference.basic_serial_port.assign [*assign]]]
+ [Assign an existing native serial port to the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.basic_serial_port [*basic_serial_port]]]
+ [Construct a basic_serial_port without opening it.
+ Construct and open a basic_serial_port.
-[heading Parameters]
-
+ Construct a basic_serial_port on an existing native serial port.
-[variablelist
+ Move-construct a basic_serial_port from another. ]
+ ]
-[[d][The device from which the data is to be read. The type must support the SyncRandomAccessReadDevice concept.]]
+ [
+ [[link boost_asio.reference.basic_serial_port.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.close [*close]]]
+ [Close the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.get_option [*get_option]]]
+ [Get an option from the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.is_open [*is_open]]]
+ [Determine whether the serial port is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
-[[offset][The offset at which the data will be read.]]
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native serial port representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.native_handle [*native_handle]]]
+ [Get the native serial port representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.open [*open]]]
+ [Open the serial port using the specified device name. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.operator_eq_ [*operator=]]]
+ [Move-assign a basic_serial_port from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.read_some [*read_some]]]
+ [Read some data from the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.send_break [*send_break]]]
+ [Send a break sequence to the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.set_option [*set_option]]]
+ [Set an option on the serial port. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.write_some [*write_some]]]
+ [Write some data to the serial port. ]
+ ]
+
+]
-[[b][The [link boost_asio.reference.basic_streambuf `basic_streambuf`] object into which the data will be read.]]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[[completion_condition][The function object to be called to determine whether the read operation is complete. The signature of the function object must be:
-``
- std::size_t completion_condition(
- // Result of latest read_some_at operation.
- const boost::system::error_code& error,
+ [
+ [[link boost_asio.reference.basic_serial_port.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
- // Number of bytes transferred so far.
- std::size_t bytes_transferred
- );
-``
-A return value of 0 indicates that the read operation is complete. A non-zero return value indicates the maximum number of bytes to be read on the next call to the device's read\_some\_at function.]]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
-[[ec][Set to indicate what error occurred, if any.]]
+ [
+ [[link boost_asio.reference.basic_serial_port.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_serial_port.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
]
+The [link boost_asio.reference.basic_serial_port `basic_serial_port`] class template provides functionality that is common to all serial ports.
-[heading Return Value]
-
-The number of bytes read. If an error occurs, returns the total number of bytes successfully transferred prior to the error.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-[endsect]
-[endsect]
+[heading Requirements]
-[section:read_until read_until]
+[*Header: ][^boost/asio/serial_port.hpp]
-[indexterm1 read_until]
-Read data into a streambuf until it contains a delimiter, matches a regular expression, or a function object indicates a match.
+[*Convenience header: ][^boost/asio.hpp]
-
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload1 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- char delim);
- `` [''''»''' [link boost_asio.reference.read_until.overload1 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload2 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- char delim,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_until.overload2 more...]]``
+[endsect]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload3 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const std::string & delim);
- `` [''''»''' [link boost_asio.reference.read_until.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload4 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const std::string & delim,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_until.overload4 more...]]``
+[section:serial_port_base serial_port_base]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload5 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const boost::regex & expr);
- `` [''''»''' [link boost_asio.reference.read_until.overload5 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t ``[link boost_asio.reference.read_until.overload6 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const boost::regex & expr,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.read_until.overload6 more...]]``
+The [link boost_asio.reference.serial_port_base `serial_port_base`] class is used as a base for the [link boost_asio.reference.basic_serial_port `basic_serial_port`] class template so that we have a common place to define the serial port options.
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename MatchCondition>
- std::size_t ``[link boost_asio.reference.read_until.overload7 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- MatchCondition match_condition,
- typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
- `` [''''»''' [link boost_asio.reference.read_until.overload7 more...]]``
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename MatchCondition>
- std::size_t ``[link boost_asio.reference.read_until.overload8 read_until]``(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- MatchCondition match_condition,
- boost::system::error_code & ec,
- typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
- `` [''''»''' [link boost_asio.reference.read_until.overload8 more...]]``
+ class serial_port_base
-[heading Requirements]
-[*Header: ][^boost/asio/read_until.hpp]
+[heading Types]
+[table
+ [[Name][Description]]
-[*Convenience header: ][^boost/asio.hpp]
+ [
+ [[link boost_asio.reference.serial_port_base__baud_rate [*baud_rate]]]
+ [Serial port option to permit changing the baud rate. ]
+
+ ]
-[section:overload1 read_until (1 of 8 overloads)]
+ [
+ [[link boost_asio.reference.serial_port_base__character_size [*character_size]]]
+ [Serial port option to permit changing the character size. ]
+
+ ]
-Read data into a streambuf until it contains a specified delimiter.
+ [
+ [[link boost_asio.reference.serial_port_base__flow_control [*flow_control]]]
+ [Serial port option to permit changing the flow control. ]
+
+ ]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- char delim);
+ [
+ [[link boost_asio.reference.serial_port_base__parity [*parity]]]
+ [Serial port option to permit changing the parity. ]
+
+ ]
-This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
+ [
+ [[link boost_asio.reference.serial_port_base__stop_bits [*stop_bits]]]
+ [Serial port option to permit changing the number of stop bits. ]
+
+ ]
-* The get area of the streambuf contains the specified delimiter.
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-* An error occurred.
+ [
+ [[link boost_asio.reference.serial_port_base._serial_port_base [*~serial_port_base]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
+]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
+[heading Requirements]
+[*Header: ][^boost/asio/serial_port_base.hpp]
-[heading Parameters]
-
+[*Convenience header: ][^boost/asio.hpp]
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+[section:_serial_port_base serial_port_base::~serial_port_base]
-[[delim][The delimiter character.]]
+[indexterm2 ~serial_port_base..serial_port_base]
+Protected destructor to prevent deletion through this type.
-]
+ ~serial_port_base();
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the delimiter.
-[heading Exceptions]
-
+[endsect]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[endsect]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
+[section:serial_port_base__baud_rate serial_port_base::baud_rate]
-[heading Example]
-
-To read data into a streambuf until a newline is encountered:
+Serial port option to permit changing the baud rate.
- boost::asio::streambuf b;
- boost::asio::read_until(s, b, '\n');
- std::istream is(&b);
- std::string line;
- std::getline(is, line);
+ class baud_rate
-After the `read_until` operation completes successfully, the buffer `b` contains the delimiter:
- { 'a', 'b', ..., 'c', '\n', 'd', 'e', ... }
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.serial_port_base__baud_rate.baud_rate [*baud_rate]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__baud_rate.load [*load]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__baud_rate.store [*store]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__baud_rate.value [*value]]]
+ []
+ ]
+
+]
-The call to `std::getline` then extracts the data up to and including the delimiter, so that the string `line` contains:
+Implements changing the baud rate for a given serial port.
- { 'a', 'b', ..., 'c', '\n' }
+[heading Requirements]
+[*Header: ][^boost/asio/serial_port_base.hpp]
-The remaining data is left in the buffer `b` as follows:
+[*Convenience header: ][^boost/asio.hpp]
- { 'd', 'e', ... }
+[section:baud_rate serial_port_base::baud_rate::baud_rate]
-This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
+[indexterm2 baud_rate..serial_port_base::baud_rate]
+ baud_rate(
+ unsigned int rate = 0);
@@ -75562,587 +78983,598 @@
-[section:overload2 read_until (2 of 8 overloads)]
-
-
-Read data into a streambuf until it contains a specified delimiter.
+[section:load serial_port_base::baud_rate::load]
+[indexterm2 load..serial_port_base::baud_rate]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- char delim,
+ boost::system::error_code load(
+ const BOOST_ASIO_OPTION_STORAGE & storage,
boost::system::error_code & ec);
-This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
+[endsect]
-* The get area of the streambuf contains the specified delimiter.
-* An error occurred.
+[section:store serial_port_base::baud_rate::store]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
+[indexterm2 store..serial_port_base::baud_rate]
+ boost::system::error_code store(
+ BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec) const;
-[heading Parameters]
-
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+[endsect]
-[[delim][The delimiter character.]]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[section:value serial_port_base::baud_rate::value]
+[indexterm2 value..serial_port_base::baud_rate]
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the delimiter. Returns 0 if an error occurred.
+ unsigned int value() const;
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
+[endsect]
[endsect]
+[section:serial_port_base__character_size serial_port_base::character_size]
-[section:overload3 read_until (3 of 8 overloads)]
+Serial port option to permit changing the character size.
-Read data into a streambuf until it contains a specified delimiter.
+ class character_size
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const std::string & delim);
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.serial_port_base__character_size.character_size [*character_size]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__character_size.load [*load]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__character_size.store [*store]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__character_size.value [*value]]]
+ []
+ ]
+
+]
-This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
+Implements changing the character size for a given serial port.
+[heading Requirements]
-* The get area of the streambuf contains the specified delimiter.
+[*Header: ][^boost/asio/serial_port_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-* An error occurred.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
+[section:character_size serial_port_base::character_size::character_size]
+[indexterm2 character_size..serial_port_base::character_size]
-[heading Parameters]
-
+ character_size(
+ unsigned int t = 8);
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
-[[delim][The delimiter string.]]
+[endsect]
-]
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the delimiter.
+[section:load serial_port_base::character_size::load]
+[indexterm2 load..serial_port_base::character_size]
-[heading Exceptions]
-
+ boost::system::error_code load(
+ const BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec);
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[endsect]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
-[heading Example]
-
-To read data into a streambuf until a newline is encountered:
+[section:store serial_port_base::character_size::store]
- boost::asio::streambuf b;
- boost::asio::read_until(s, b, "\r\n");
- std::istream is(&b);
- std::string line;
- std::getline(is, line);
+[indexterm2 store..serial_port_base::character_size]
+ boost::system::error_code store(
+ BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec) const;
-After the `read_until` operation completes successfully, the buffer `b` contains the delimiter:
- { 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+[endsect]
-The call to `std::getline` then extracts the data up to and including the delimiter, so that the string `line` contains:
- { 'a', 'b', ..., 'c', '\r', '\n' }
+[section:value serial_port_base::character_size::value]
-The remaining data is left in the buffer `b` as follows:
+[indexterm2 value..serial_port_base::character_size]
- { 'd', 'e', ... }
+ unsigned int value() const;
-This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
+[endsect]
[endsect]
+[section:serial_port_base__flow_control serial_port_base::flow_control]
-[section:overload4 read_until (4 of 8 overloads)]
+Serial port option to permit changing the flow control.
-Read data into a streambuf until it contains a specified delimiter.
+ class flow_control
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const std::string & delim,
- boost::system::error_code & ec);
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-This function is used to read data into the specified streambuf until the streambuf's get area contains the specified delimiter. The call will block until one of the following conditions is true:
+ [[link boost_asio.reference.serial_port_base__flow_control.type [*type]]]
+ []
+
+ ]
+]
-* The get area of the streambuf contains the specified delimiter.
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.serial_port_base__flow_control.flow_control [*flow_control]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__flow_control.load [*load]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__flow_control.store [*store]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__flow_control.value [*value]]]
+ []
+ ]
+
+]
-* An error occurred.
+Implements changing the flow control for a given serial port.
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains the delimiter, the function returns immediately.
+[heading Requirements]
+[*Header: ][^boost/asio/serial_port_base.hpp]
-[heading Parameters]
-
+[*Convenience header: ][^boost/asio.hpp]
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+[section:flow_control serial_port_base::flow_control::flow_control]
-[[delim][The delimiter string.]]
+[indexterm2 flow_control..serial_port_base::flow_control]
-[[ec][Set to indicate what error occurred, if any.]]
+ flow_control(
+ type t = none);
-]
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the delimiter. Returns 0 if an error occurred.
+[endsect]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond the delimiter. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
+[section:load serial_port_base::flow_control::load]
+[indexterm2 load..serial_port_base::flow_control]
+ boost::system::error_code load(
+ const BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec);
-[endsect]
+[endsect]
-[section:overload5 read_until (5 of 8 overloads)]
-Read data into a streambuf until some part of the data it contains matches a regular expression.
+[section:store serial_port_base::flow_control::store]
+[indexterm2 store..serial_port_base::flow_control]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const boost::regex & expr);
+ boost::system::error_code store(
+ BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec) const;
-This function is used to read data into the specified streambuf until the streambuf's get area contains some data that matches a regular expression. The call will block until one of the following conditions is true:
+[endsect]
-* A substring of the streambuf's get area matches the regular expression.
-* An error occurred.
+[section:type serial_port_base::flow_control::type]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains data that matches the regular expression, the function returns immediately.
+[indexterm2 type..serial_port_base::flow_control]
+ enum type
-[heading Parameters]
-
+[indexterm2 none..serial_port_base::flow_control]
+[indexterm2 software..serial_port_base::flow_control]
+[indexterm2 hardware..serial_port_base::flow_control]
+[heading Values]
[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+ [
+ [none]
+ []
+ ]
-[[expr][The regular expression.]]
+ [
+ [software]
+ []
+ ]
+
+ [
+ [hardware]
+ []
+ ]
]
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the substring that matches the regular expression.
+[endsect]
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[section:value serial_port_base::flow_control::value]
+[indexterm2 value..serial_port_base::flow_control]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the regular expression. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
+ type value() const;
-[heading Example]
-
-To read data into a streambuf until a CR-LF sequence is encountered:
- boost::asio::streambuf b;
- boost::asio::read_until(s, b, boost::regex("\r\n"));
- std::istream is(&b);
- std::string line;
- std::getline(is, line);
+[endsect]
-After the `read_until` operation completes successfully, the buffer `b` contains the data which matched the regular expression:
- { 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
+[endsect]
+[section:serial_port_base__parity serial_port_base::parity]
-The call to `std::getline` then extracts the data up to and including the match, so that the string `line` contains:
- { 'a', 'b', ..., 'c', '\r', '\n' }
+Serial port option to permit changing the parity.
-The remaining data is left in the buffer `b` as follows:
+ class parity
- { 'd', 'e', ... }
+[heading Types]
+[table
+ [[Name][Description]]
-This data may be the start of a new line, to be extracted by a subsequent `read_until` operation.
+ [
+ [[link boost_asio.reference.serial_port_base__parity.type [*type]]]
+ []
+
+ ]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.serial_port_base__parity.load [*load]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__parity.parity [*parity]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__parity.store [*store]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__parity.value [*value]]]
+ []
+ ]
+
+]
+
+Implements changing the parity for a given serial port.
+[heading Requirements]
+[*Header: ][^boost/asio/serial_port_base.hpp]
-[section:overload6 read_until (6 of 8 overloads)]
+[*Convenience header: ][^boost/asio.hpp]
-Read data into a streambuf until some part of the data it contains matches a regular expression.
+[section:load serial_port_base::parity::load]
+[indexterm2 load..serial_port_base::parity]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- const boost::regex & expr,
+ boost::system::error_code load(
+ const BOOST_ASIO_OPTION_STORAGE & storage,
boost::system::error_code & ec);
-This function is used to read data into the specified streambuf until the streambuf's get area contains some data that matches a regular expression. The call will block until one of the following conditions is true:
+[endsect]
-* A substring of the streambuf's get area matches the regular expression.
-* An error occurred.
+[section:parity serial_port_base::parity::parity]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the streambuf's get area already contains data that matches the regular expression, the function returns immediately.
+[indexterm2 parity..serial_port_base::parity]
+ parity(
+ type t = none);
-[heading Parameters]
-
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+[endsect]
-[[expr][The regular expression.]]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[section:store serial_port_base::parity::store]
+
+[indexterm2 store..serial_port_base::parity]
+
+ boost::system::error_code store(
+ BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec) const;
+
+
+
+[endsect]
+
-[heading Return Value]
-
-The number of bytes in the streambuf's get area up to and including the substring that matches the regular expression. Returns 0 if an error occurred.
+[section:type serial_port_base::parity::type]
+[indexterm2 type..serial_port_base::parity]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the regular expression. An application will typically leave that data in the streambuf for a subsequent read\_until operation to examine.
+ enum type
+[indexterm2 none..serial_port_base::parity]
+[indexterm2 odd..serial_port_base::parity]
+[indexterm2 even..serial_port_base::parity]
+[heading Values]
+[variablelist
+ [
+ [none]
+ []
+ ]
-[endsect]
+ [
+ [odd]
+ []
+ ]
+ [
+ [even]
+ []
+ ]
+]
-[section:overload7 read_until (7 of 8 overloads)]
-Read data into a streambuf until a function object indicates a match.
+[endsect]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename MatchCondition>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- MatchCondition match_condition,
- typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
+[section:value serial_port_base::parity::value]
-This function is used to read data into the specified streambuf until a user-defined match condition function object, when applied to the data contained in the streambuf, indicates a successful match. The call will block until one of the following conditions is true:
+[indexterm2 value..serial_port_base::parity]
+ type value() const;
-* The match condition function object returns a std::pair where the second element evaluates to true.
-* An error occurred.
+[endsect]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the match condition function object already indicates a match, the function returns immediately.
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
+[section:serial_port_base__stop_bits serial_port_base::stop_bits]
-[[b][A streambuf object into which the data will be read.]]
-[[match_condition][The function object to be called to determine whether a match exists. The signature of the function object must be:
-``
- pair<iterator, bool> match_condition(iterator begin, iterator end);
-``
-where `iterator` represents the type:
-``
- buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
-``
-The iterator parameters `begin` and `end` define the range of bytes to be scanned to determine whether there is a match. The `first` member of the return value is an iterator marking one-past-the-end of the bytes that have been consumed by the match function. This iterator is used to calculate the `begin` parameter for any subsequent invocation of the match condition. The `second` member of the return value is true if a match has been found, false otherwise.]]
+Serial port option to permit changing the number of stop bits.
-]
+ class stop_bits
-[heading Return Value]
-
-The number of bytes in the streambuf's get area that have been fully consumed by the match function.
+[heading Types]
+[table
+ [[Name][Description]]
-[heading Exceptions]
-
+ [
-[variablelist
+ [[link boost_asio.reference.serial_port_base__stop_bits.type [*type]]]
+ []
-[[boost::system::system_error][Thrown on failure.]]
+ ]
]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the function object. An application will typically leave that data in the streambuf for a subsequent
-
-The default implementation of the `is_match_condition` type trait evaluates to true for function pointers and function objects with a `result_type` typedef. It must be specialised for other user-defined function objects.
+ [
+ [[link boost_asio.reference.serial_port_base__stop_bits.load [*load]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__stop_bits.stop_bits [*stop_bits]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__stop_bits.store [*store]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.serial_port_base__stop_bits.value [*value]]]
+ []
+ ]
+
+]
+Implements changing the number of stop bits for a given serial port.
-[heading Examples]
-
-To read data into a streambuf until whitespace is encountered:
+[heading Requirements]
- typedef boost::asio::buffers_iterator<
- boost::asio::streambuf::const_buffers_type> iterator;
+[*Header: ][^boost/asio/serial_port_base.hpp]
- std::pair<iterator, bool>
- match_whitespace(iterator begin, iterator end)
- {
- iterator i = begin;
- while (i != end)
- if (std::isspace(*i++))
- return std::make_pair(i, true);
- return std::make_pair(i, false);
- }
- ...
- boost::asio::streambuf b;
- boost::asio::read_until(s, b, match_whitespace);
+[*Convenience header: ][^boost/asio.hpp]
+[section:load serial_port_base::stop_bits::load]
+[indexterm2 load..serial_port_base::stop_bits]
-To read data into a streambuf until a matching character is found:
+ boost::system::error_code load(
+ const BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec);
- class match_char
- {
- public:
- explicit match_char(char c) : c_(c) {}
- template <typename Iterator>
- std::pair<Iterator, bool> operator()(
- Iterator begin, Iterator end) const
- {
- Iterator i = begin;
- while (i != end)
- if (c_ == *i++)
- return std::make_pair(i, true);
- return std::make_pair(i, false);
- }
- private:
- char c_;
- };
+[endsect]
- namespace asio {
- template <> struct is_match_condition<match_char>
- : public boost::true_type {};
- } // namespace asio
- ...
- boost::asio::streambuf b;
- boost::asio::read_until(s, b, match_char('a'));
+[section:stop_bits serial_port_base::stop_bits::stop_bits]
+[indexterm2 stop_bits..serial_port_base::stop_bits]
+ stop_bits(
+ type t = one);
-[endsect]
+[endsect]
-[section:overload8 read_until (8 of 8 overloads)]
-Read data into a streambuf until a function object indicates a match.
+[section:store serial_port_base::stop_bits::store]
+[indexterm2 store..serial_port_base::stop_bits]
- template<
- typename ``[link boost_asio.reference.SyncReadStream SyncReadStream]``,
- typename Allocator,
- typename MatchCondition>
- std::size_t read_until(
- SyncReadStream & s,
- boost::asio::basic_streambuf< Allocator > & b,
- MatchCondition match_condition,
- boost::system::error_code & ec,
- typename boost::enable_if< is_match_condition< MatchCondition > >::type * = 0);
+ boost::system::error_code store(
+ BOOST_ASIO_OPTION_STORAGE & storage,
+ boost::system::error_code & ec) const;
-This function is used to read data into the specified streambuf until a user-defined match condition function object, when applied to the data contained in the streambuf, indicates a successful match. The call will block until one of the following conditions is true:
+[endsect]
-* The match condition function object returns a std::pair where the second element evaluates to true.
-* An error occurred.
+[section:type serial_port_base::stop_bits::type]
-This operation is implemented in terms of zero or more calls to the stream's read\_some function. If the match condition function object already indicates a match, the function returns immediately.
+[indexterm2 type..serial_port_base::stop_bits]
+ enum type
-[heading Parameters]
-
+[indexterm2 one..serial_port_base::stop_bits]
+[indexterm2 onepointfive..serial_port_base::stop_bits]
+[indexterm2 two..serial_port_base::stop_bits]
+[heading Values]
[variablelist
-
-[[s][The stream from which the data is to be read. The type must support the SyncReadStream concept.]]
-[[b][A streambuf object into which the data will be read.]]
+ [
+ [one]
+ []
+ ]
-[[match_condition][The function object to be called to determine whether a match exists. The signature of the function object must be:
-``
- pair<iterator, bool> match_condition(iterator begin, iterator end);
-``
-where `iterator` represents the type:
-``
- buffers_iterator<basic_streambuf<Allocator>::const_buffers_type>
-``
-The iterator parameters `begin` and `end` define the range of bytes to be scanned to determine whether there is a match. The `first` member of the return value is an iterator marking one-past-the-end of the bytes that have been consumed by the match function. This iterator is used to calculate the `begin` parameter for any subsequent invocation of the match condition. The `second` member of the return value is true if a match has been found, false otherwise.]]
+ [
+ [onepointfive]
+ []
+ ]
-[[ec][Set to indicate what error occurred, if any.]]
+ [
+ [two]
+ []
+ ]
]
-[heading Return Value]
-
-The number of bytes in the streambuf's get area that have been fully consumed by the match function. Returns 0 if an error occurred.
+[endsect]
-[heading Remarks]
-
-After a successful read\_until operation, the streambuf may contain additional data beyond that which matched the function object. An application will typically leave that data in the streambuf for a subsequent
-The default implementation of the `is_match_condition` type trait evaluates to true for function pointers and function objects with a `result_type` typedef. It must be specialised for other user-defined function objects.
+[section:value serial_port_base::stop_bits::value]
+
+[indexterm2 value..serial_port_base::stop_bits]
+
+ type value() const;
[endsect]
+
[endsect]
-[section:seq_packet_socket_service seq_packet_socket_service]
+[section:serial_port_service serial_port_service]
-Default service implementation for a sequenced packet socket.
+Default service implementation for a serial port.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class seq_packet_socket_service :
+ class serial_port_service :
public io_service::service
@@ -76152,36 +79584,22 @@
[
- [[link boost_asio.reference.seq_packet_socket_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.seq_packet_socket_service.implementation_type [*implementation_type]]]
- [The type of a sequenced packet socket implementation. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.seq_packet_socket_service.native_handle_type [*native_handle_type]]]
- [The native socket type. ]
+ [[link boost_asio.reference.serial_port_service.implementation_type [*implementation_type]]]
+ [The type of a serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native socket type. ]
+ [[link boost_asio.reference.serial_port_service.native_handle_type [*native_handle_type]]]
+ [The native handle type. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
+ [[link boost_asio.reference.serial_port_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native handle type. ]
]
@@ -76192,157 +79610,103 @@
[[Name][Description]]
[
- [[link boost_asio.reference.seq_packet_socket_service.assign [*assign]]]
- [Assign an existing native socket to a sequenced packet socket. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.async_receive [*async_receive]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.async_send [*async_send]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.available [*available]]]
- [Determine the number of bytes available for reading. ]
+ [[link boost_asio.reference.serial_port_service.assign [*assign]]]
+ [Assign an existing native handle to a serial port. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.bind [*bind]]]
- [Bind the sequenced packet socket to the specified local endpoint. ]
+ [[link boost_asio.reference.serial_port_service.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
+ [[link boost_asio.reference.serial_port_service.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.close [*close]]]
- [Close a sequenced packet socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the handle. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.connect [*connect]]]
- [Connect the sequenced packet socket to the specified endpoint. ]
+ [[link boost_asio.reference.serial_port_service.close [*close]]]
+ [Close a serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.construct [*construct]]]
- [Construct a new sequenced packet socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.construct [*construct]]]
+ [Construct a new serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.destroy [*destroy]]]
- [Destroy a sequenced packet socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.destroy [*destroy]]]
+ [Destroy a serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.get_io_service [*get_io_service]]]
+ [[link boost_asio.reference.serial_port_service.get_io_service [*get_io_service]]]
[Get the io_service object that owns the service. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.get_option [*get_option]]]
- [Get a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.is_open [*is_open]]]
- [Determine whether the socket is open. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.local_endpoint [*local_endpoint]]]
- [Get the local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.move_assign [*move_assign]]]
- [Move-assign from another sequenced packet socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.seq_packet_socket_service.move_construct [*move_construct]]]
- [Move-construct a new sequenced packet socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.get_option [*get_option]]]
+ [Get a serial port option. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.is_open [*is_open]]]
+ [Determine whether the handle is open. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.native_handle [*native_handle]]]
- [Get the native socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.move_assign [*move_assign]]]
+ [Move-assign from another serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
-
- Sets the non-blocking mode of the native socket implementation. ]
+ [[link boost_asio.reference.serial_port_service.move_construct [*move_construct]]]
+ [Move-construct a new serial port implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
-
- Sets the non-blocking mode of the socket. ]
+ [[link boost_asio.reference.serial_port_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native handle implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.open [*open]]]
- [Open a sequenced packet socket. ]
+ [[link boost_asio.reference.serial_port_service.native_handle [*native_handle]]]
+ [Get the native handle implementation. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.receive [*receive]]]
- [Receive some data from the peer. ]
+ [[link boost_asio.reference.serial_port_service.open [*open]]]
+ [Open a serial port. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint. ]
+ [[link boost_asio.reference.serial_port_service.read_some [*read_some]]]
+ [Read some data from the stream. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.send [*send]]]
- [Send the given data to the peer. ]
+ [[link boost_asio.reference.serial_port_service.send_break [*send_break]]]
+ [Send a break sequence to the serial port. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.seq_packet_socket_service [*seq_packet_socket_service]]]
- [Construct a new sequenced packet socket service for the specified io_service. ]
+ [[link boost_asio.reference.serial_port_service.serial_port_service [*serial_port_service]]]
+ [Construct a new serial port service for the specified io_service. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.set_option [*set_option]]]
- [Set a socket option. ]
+ [[link boost_asio.reference.serial_port_service.set_option [*set_option]]]
+ [Set a serial port option. ]
]
[
- [[link boost_asio.reference.seq_packet_socket_service.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
+ [[link boost_asio.reference.serial_port_service.write_some [*write_some]]]
+ [Write the given data to the stream. ]
]
]
@@ -76352,7 +79716,7 @@
[[Name][Description]]
[
- [[link boost_asio.reference.seq_packet_socket_service.id [*id]]]
+ [[link boost_asio.reference.serial_port_service.id [*id]]]
[The unique service identifier. ]
]
@@ -76360,21 +79724,20 @@
[heading Requirements]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Header: ][^boost/asio/serial_port_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:assign seq_packet_socket_service::assign]
+[section:assign serial_port_service::assign]
-[indexterm2 assign..seq_packet_socket_service]
-Assign an existing native socket to a sequenced packet socket.
+[indexterm2 assign..serial_port_service]
+Assign an existing native handle to a serial port.
boost::system::error_code assign(
implementation_type & impl,
- const protocol_type & protocol,
- const native_handle_type & native_socket,
+ const native_handle_type & handle,
boost::system::error_code & ec);
@@ -76383,18 +79746,101 @@
-[section:async_connect seq_packet_socket_service::async_connect]
+[section:async_read_some serial_port_service::async_read_some]
-[indexterm2 async_connect..seq_packet_socket_service]
-Start an asynchronous connect.
+[indexterm2 async_read_some..serial_port_service]
+Start an asynchronous read.
template<
- typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
- void async_connect(
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
implementation_type & impl,
- const endpoint_type & peer_endpoint,
- ConnectHandler handler);
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
+
+
+
+[endsect]
+
+
+
+[section:async_write_some serial_port_service::async_write_some]
+
+[indexterm2 async_write_some..serial_port_service]
+Start an asynchronous write.
+
+
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
+
+
+
+[endsect]
+
+
+
+[section:cancel serial_port_service::cancel]
+
+[indexterm2 cancel..serial_port_service]
+Cancel all asynchronous operations associated with the handle.
+
+
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:close serial_port_service::close]
+
+[indexterm2 close..serial_port_service]
+Close a serial port implementation.
+
+
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:construct serial_port_service::construct]
+
+[indexterm2 construct..serial_port_service]
+Construct a new serial port implementation.
+
+
+ void construct(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:destroy serial_port_service::destroy]
+
+[indexterm2 destroy..serial_port_service]
+Destroy a serial port implementation.
+
+
+ void destroy(
+ implementation_type & impl);
@@ -76402,21 +79848,16 @@
-[section:async_receive seq_packet_socket_service::async_receive]
+[section:get_io_service serial_port_service::get_io_service]
-[indexterm2 async_receive..seq_packet_socket_service]
-Start an asynchronous receive.
+['Inherited from io_service.]
+
+[indexterm2 get_io_service..serial_port_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags in_flags,
- socket_base::message_flags & out_flags,
- ReadHandler handler);
+
+ boost::asio::io_service & get_io_service();
@@ -76424,20 +79865,18 @@
-[section:async_send seq_packet_socket_service::async_send]
+[section:get_option serial_port_service::get_option]
-[indexterm2 async_send..seq_packet_socket_service]
-Start an asynchronous send.
+[indexterm2 get_option..serial_port_service]
+Get a serial port option.
template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- WriteHandler handler);
+ typename ``[link boost_asio.reference.GettableSerialPortOption GettableSerialPortOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSerialPortOption & option,
+ boost::system::error_code & ec) const;
@@ -76445,15 +79884,13 @@
-[section:at_mark seq_packet_socket_service::at_mark]
+[section:id serial_port_service::id]
-[indexterm2 at_mark..seq_packet_socket_service]
-Determine whether the socket is at the out-of-band data mark.
+[indexterm2 id..serial_port_service]
+The unique service identifier.
- bool at_mark(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+ static boost::asio::io_service::id id;
@@ -76461,32 +79898,35 @@
-[section:available seq_packet_socket_service::available]
+[section:implementation_type serial_port_service::implementation_type]
-[indexterm2 available..seq_packet_socket_service]
-Determine the number of bytes available for reading.
+[indexterm2 implementation_type..serial_port_service]
+The type of a serial port implementation.
- std::size_t available(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+ typedef implementation_defined implementation_type;
+
+
+
+[heading Requirements]
+[*Header: ][^boost/asio/serial_port_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:bind seq_packet_socket_service::bind]
+[section:is_open serial_port_service::is_open]
-[indexterm2 bind..seq_packet_socket_service]
-Bind the sequenced packet socket to the specified local endpoint.
+[indexterm2 is_open..serial_port_service]
+Determine whether the handle is open.
- boost::system::error_code bind(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
+ bool is_open(
+ const implementation_type & impl) const;
@@ -76494,15 +79934,16 @@
-[section:cancel seq_packet_socket_service::cancel]
+[section:move_assign serial_port_service::move_assign]
-[indexterm2 cancel..seq_packet_socket_service]
-Cancel all asynchronous operations associated with the socket.
+[indexterm2 move_assign..serial_port_service]
+Move-assign from another serial port implementation.
- boost::system::error_code cancel(
+ void move_assign(
implementation_type & impl,
- boost::system::error_code & ec);
+ serial_port_service & other_service,
+ implementation_type & other_impl);
@@ -76510,15 +79951,15 @@
-[section:close seq_packet_socket_service::close]
+[section:move_construct serial_port_service::move_construct]
-[indexterm2 close..seq_packet_socket_service]
-Close a sequenced packet socket implementation.
+[indexterm2 move_construct..serial_port_service]
+Move-construct a new serial port implementation.
- boost::system::error_code close(
+ void move_construct(
implementation_type & impl,
- boost::system::error_code & ec);
+ implementation_type & other_impl);
@@ -76526,16 +79967,14 @@
-[section:connect seq_packet_socket_service::connect]
+[section:native serial_port_service::native]
-[indexterm2 connect..seq_packet_socket_service]
-Connect the sequenced packet socket to the specified endpoint.
+[indexterm2 native..serial_port_service]
+(Deprecated: Use `native_handle()`.) Get the native handle implementation.
- boost::system::error_code connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- boost::system::error_code & ec);
+ native_type native(
+ implementation_type & impl);
@@ -76543,13 +79982,13 @@
-[section:construct seq_packet_socket_service::construct]
+[section:native_handle serial_port_service::native_handle]
-[indexterm2 construct..seq_packet_socket_service]
-Construct a new sequenced packet socket implementation.
+[indexterm2 native_handle..serial_port_service]
+Get the native handle implementation.
- void construct(
+ native_handle_type native_handle(
implementation_type & impl);
@@ -76558,34 +79997,40 @@
-[section:destroy seq_packet_socket_service::destroy]
+[section:native_handle_type serial_port_service::native_handle_type]
-[indexterm2 destroy..seq_packet_socket_service]
-Destroy a sequenced packet socket implementation.
+[indexterm2 native_handle_type..serial_port_service]
+The native handle type.
- void destroy(
- implementation_type & impl);
+ typedef implementation_defined native_handle_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/serial_port_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:endpoint_type seq_packet_socket_service::endpoint_type]
+[section:native_type serial_port_service::native_type]
-[indexterm2 endpoint_type..seq_packet_socket_service]
-The endpoint type.
+[indexterm2 native_type..serial_port_service]
+(Deprecated: Use native\_handle\_type.) The native handle type.
- typedef Protocol::endpoint endpoint_type;
+ typedef implementation_defined native_type;
[heading Requirements]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Header: ][^boost/asio/serial_port_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -76594,16 +80039,16 @@
-[section:get_io_service seq_packet_socket_service::get_io_service]
-
-
-['Inherited from io_service.]
+[section:open serial_port_service::open]
-[indexterm2 get_io_service..seq_packet_socket_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[indexterm2 open..serial_port_service]
+Open a serial port.
- boost::asio::io_service & get_io_service();
+ boost::system::error_code open(
+ implementation_type & impl,
+ const std::string & device,
+ boost::system::error_code & ec);
@@ -76611,18 +80056,18 @@
-[section:get_option seq_packet_socket_service::get_option]
+[section:read_some serial_port_service::read_some]
-[indexterm2 get_option..seq_packet_socket_service]
-Get a socket option.
+[indexterm2 read_some..serial_port_service]
+Read some data from the stream.
template<
- typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSocketOption & option,
- boost::system::error_code & ec) const;
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
@@ -76630,13 +80075,15 @@
-[section:id seq_packet_socket_service::id]
+[section:send_break serial_port_service::send_break]
-[indexterm2 id..seq_packet_socket_service]
-The unique service identifier.
+[indexterm2 send_break..serial_port_service]
+Send a break sequence to the serial port.
- static boost::asio::io_service::id id;
+ boost::system::error_code send_break(
+ implementation_type & impl,
+ boost::system::error_code & ec);
@@ -76644,38 +80091,51 @@
-[section:implementation_type seq_packet_socket_service::implementation_type]
+[section:serial_port_service serial_port_service::serial_port_service]
-[indexterm2 implementation_type..seq_packet_socket_service]
-The type of a sequenced packet socket implementation.
+[indexterm2 serial_port_service..serial_port_service]
+Construct a new serial port service for the specified [link boost_asio.reference.io_service `io_service`].
- typedef implementation_defined implementation_type;
+ serial_port_service(
+ boost::asio::io_service & io_service);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+
+[section:set_option serial_port_service::set_option]
+
+[indexterm2 set_option..serial_port_service]
+Set a serial port option.
+
+
+ template<
+ typename ``[link boost_asio.reference.SettableSerialPortOption SettableSerialPortOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSerialPortOption & option,
+ boost::system::error_code & ec);
+
[endsect]
-[section:io_control seq_packet_socket_service::io_control]
+[section:write_some serial_port_service::write_some]
-[indexterm2 io_control..seq_packet_socket_service]
-Perform an IO control command on the socket.
+[indexterm2 write_some..serial_port_service]
+Write the given data to the stream.
template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
implementation_type & impl,
- IoControlCommand & command,
+ const ConstBufferSequence & buffers,
boost::system::error_code & ec);
@@ -76684,30 +80144,40 @@
-[section:is_open seq_packet_socket_service::is_open]
+[endsect]
-[indexterm2 is_open..seq_packet_socket_service]
-Determine whether the socket is open.
+[section:service_already_exists service_already_exists]
- bool is_open(
- const implementation_type & impl) const;
+Exception thrown when trying to add a duplicate service to an [link boost_asio.reference.io_service `io_service`].
+
+ class service_already_exists
-[endsect]
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.service_already_exists.service_already_exists [*service_already_exists]]]
+ []
+ ]
+
+]
+[heading Requirements]
+[*Header: ][^boost/asio/io_service.hpp]
-[section:local_endpoint seq_packet_socket_service::local_endpoint]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 local_endpoint..seq_packet_socket_service]
-Get the local endpoint.
+[section:service_already_exists service_already_exists::service_already_exists]
- endpoint_type local_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+[indexterm2 service_already_exists..service_already_exists]
+
+ service_already_exists();
@@ -76715,82 +80185,183 @@
-[section:move_assign seq_packet_socket_service::move_assign]
+[endsect]
-[indexterm2 move_assign..seq_packet_socket_service]
-Move-assign from another sequenced packet socket implementation.
+[section:signal_set signal_set]
- void move_assign(
- implementation_type & impl,
- seq_packet_socket_service & other_service,
- implementation_type & other_impl);
+[indexterm1 signal_set]
+Typedef for the typical usage of a signal set.
+ typedef basic_signal_set signal_set;
-[endsect]
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[section:move_construct seq_packet_socket_service::move_construct]
+ [[link boost_asio.reference.basic_signal_set.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
-[indexterm2 move_construct..seq_packet_socket_service]
-Move-construct a new sequenced packet socket implementation.
+ [
+
+ [[link boost_asio.reference.basic_signal_set.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+]
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_signal_set.add [*add]]]
+ [Add a signal to a signal_set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.async_wait [*async_wait]]]
+ [Start an asynchronous operation to wait for a signal to be delivered. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.basic_signal_set [*basic_signal_set]]]
+ [Construct a signal set without adding any signals.
+ Construct a signal set and add one signal.
-[endsect]
+ Construct a signal set and add two signals.
+ Construct a signal set and add three signals. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.cancel [*cancel]]]
+ [Cancel all operations associated with the signal set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.clear [*clear]]]
+ [Remove all signals from a signal_set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.remove [*remove]]]
+ [Remove a signal from a signal_set. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[section:native seq_packet_socket_service::native]
+ [
+ [[link boost_asio.reference.basic_signal_set.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_signal_set.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
-[indexterm2 native..seq_packet_socket_service]
-(Deprecated: Use `native_handle()`.) Get the native socket implementation.
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_signal_set.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
- native_type native(
- implementation_type & impl);
+ [
+ [[link boost_asio.reference.basic_signal_set.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
+The [link boost_asio.reference.basic_signal_set `basic_signal_set`] class template provides the ability to perform an asynchronous wait for one or more signals to occur.
-[endsect]
+Most applications will use the [link boost_asio.reference.signal_set `signal_set`] typedef.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[section:native_handle seq_packet_socket_service::native_handle]
+[*Shared] [*objects:] Unsafe.
-[indexterm2 native_handle..seq_packet_socket_service]
-Get the native socket implementation.
+[heading Example]
+
+Performing an asynchronous wait:
- native_handle_type native_handle(
- implementation_type & impl);
+ void handler(
+ const boost::system::error_code& error,
+ int signal_number)
+ {
+ if (!error)
+ {
+ // A signal occurred.
+ }
+ }
+ ...
+ // Construct a signal set registered for process termination.
+ boost::asio::signal_set signals(io_service, SIGINT, SIGTERM);
-[endsect]
+ // Start an asynchronous wait for one of the signals to occur.
+ signals.async_wait(handler);
-[section:native_handle_type seq_packet_socket_service::native_handle_type]
-[indexterm2 native_handle_type..seq_packet_socket_service]
-The native socket type.
+[heading Queueing of signal notifications]
+
- typedef implementation_defined native_handle_type;
+
+If a signal is registered with a signal\_set, and the signal occurs when there are no waiting handlers, then the signal notification is queued. The next async\_wait operation on that signal\_set will dequeue the notification. If multiple notifications are queued, subsequent async\_wait operations dequeue them one at a time. Signal notifications are dequeued in order of ascending signal number.
+
+If a signal number is removed from a signal\_set (using the `remove` or `erase` member functions) then any queued notifications for that signal are discarded.
+
+
+[heading Multiple registration of signals]
+
+
+
+The same signal number may be registered with different signal\_set objects. When the signal occurs, one handler is called for each signal\_set object.
+
+Note that multiple registration only works for signals that are registered using Asio. The application must not also register a signal handler using functions such as `signal()` or `sigaction()`.
+[heading Signal masking on POSIX platforms]
+
+
+
+POSIX allows signals to be blocked using functions such as `sigprocmask()` and `pthread_sigmask()`. For signals to be delivered, programs must ensure that any signals registered using signal\_set objects are unblocked in at least one thread.
+
[heading Requirements]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+[*Header: ][^boost/asio/signal_set.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -76798,51 +80369,107 @@
[endsect]
-[section:native_non_blocking seq_packet_socket_service::native_non_blocking]
-
-[indexterm2 native_non_blocking..seq_packet_socket_service]
-Gets the non-blocking mode of the native socket implementation.
+[section:signal_set_service signal_set_service]
- bool ``[link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload1 more...]]``
+Default service implementation for a signal set.
-Sets the non-blocking mode of the native socket implementation.
+ class signal_set_service :
+ public io_service::service
- boost::system::error_code ``[link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.native_non_blocking.overload2 more...]]``
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[section:overload1 seq_packet_socket_service::native_non_blocking (1 of 2 overloads)]
+ [[link boost_asio.reference.signal_set_service.implementation_type [*implementation_type]]]
+ [The type of a signal set implementation. ]
+
+ ]
+]
-Gets the non-blocking mode of the native socket implementation.
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.signal_set_service.add [*add]]]
+ [Add a signal to a signal_set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.async_wait [*async_wait]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.cancel [*cancel]]]
+ [Cancel all operations associated with the signal set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.clear [*clear]]]
+ [Remove all signals from a signal_set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.construct [*construct]]]
+ [Construct a new signal set implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.destroy [*destroy]]]
+ [Destroy a signal set implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.remove [*remove]]]
+ [Remove a signal to a signal_set. ]
+ ]
+
+ [
+ [[link boost_asio.reference.signal_set_service.signal_set_service [*signal_set_service]]]
+ [Construct a new signal set service for the specified io_service. ]
+ ]
+
+]
- bool native_non_blocking(
- const implementation_type & impl) const;
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.signal_set_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+]
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/signal_set_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:overload2 seq_packet_socket_service::native_non_blocking (2 of 2 overloads)]
+[section:add signal_set_service::add]
-Sets the non-blocking mode of the native socket implementation.
+[indexterm2 add..signal_set_service]
+Add a signal to a signal\_set.
- boost::system::error_code native_non_blocking(
+ boost::system::error_code add(
implementation_type & impl,
- bool mode,
+ int signal_number,
boost::system::error_code & ec);
@@ -76850,58 +80477,32 @@
[endsect]
-[endsect]
-
-
-[section:native_type seq_packet_socket_service::native_type]
-
-[indexterm2 native_type..seq_packet_socket_service]
-(Deprecated: Use native\_handle\_type.) The native socket type.
-
-
- typedef implementation_defined native_type;
-
+[section:async_wait signal_set_service::async_wait]
-[heading Requirements]
+[indexterm2 async_wait..signal_set_service]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
+ template<
+ typename ``[link boost_asio.reference.SignalHandler SignalHandler]``>
+ void async_wait(
+ implementation_type & impl,
+ SignalHandler handler);
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:non_blocking seq_packet_socket_service::non_blocking]
-
-[indexterm2 non_blocking..seq_packet_socket_service]
-Gets the non-blocking mode of the socket.
-
-
- bool ``[link boost_asio.reference.seq_packet_socket_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.non_blocking.overload1 more...]]``
+[section:cancel signal_set_service::cancel]
-Sets the non-blocking mode of the socket.
+[indexterm2 cancel..signal_set_service]
+Cancel all operations associated with the signal set.
- boost::system::error_code ``[link boost_asio.reference.seq_packet_socket_service.non_blocking.overload2 non_blocking]``(
+ boost::system::error_code cancel(
implementation_type & impl,
- bool mode,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.seq_packet_socket_service.non_blocking.overload2 more...]]``
-
-
-[section:overload1 seq_packet_socket_service::non_blocking (1 of 2 overloads)]
-
-
-Gets the non-blocking mode of the socket.
-
-
- bool non_blocking(
- const implementation_type & impl) const;
@@ -76909,15 +80510,14 @@
-[section:overload2 seq_packet_socket_service::non_blocking (2 of 2 overloads)]
-
+[section:clear signal_set_service::clear]
-Sets the non-blocking mode of the socket.
+[indexterm2 clear..signal_set_service]
+Remove all signals from a signal\_set.
- boost::system::error_code non_blocking(
+ boost::system::error_code clear(
implementation_type & impl,
- bool mode,
boost::system::error_code & ec);
@@ -76925,19 +80525,15 @@
[endsect]
-[endsect]
-
-[section:open seq_packet_socket_service::open]
+[section:construct signal_set_service::construct]
-[indexterm2 open..seq_packet_socket_service]
-Open a sequenced packet socket.
+[indexterm2 construct..signal_set_service]
+Construct a new signal set implementation.
- boost::system::error_code open(
- implementation_type & impl,
- const protocol_type & protocol,
- boost::system::error_code & ec);
+ void construct(
+ implementation_type & impl);
@@ -76945,41 +80541,31 @@
-[section:protocol_type seq_packet_socket_service::protocol_type]
-
-[indexterm2 protocol_type..seq_packet_socket_service]
-The protocol type.
-
+[section:destroy signal_set_service::destroy]
- typedef Protocol protocol_type;
+[indexterm2 destroy..signal_set_service]
+Destroy a signal set implementation.
+ void destroy(
+ implementation_type & impl);
-[heading Requirements]
-[*Header: ][^boost/asio/seq_packet_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[endsect]
+[section:get_io_service signal_set_service::get_io_service]
-[section:receive seq_packet_socket_service::receive]
+['Inherited from io_service.]
-[indexterm2 receive..seq_packet_socket_service]
-Receive some data from the peer.
+[indexterm2 get_io_service..signal_set_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags in_flags,
- socket_base::message_flags & out_flags,
- boost::system::error_code & ec);
+ boost::asio::io_service & get_io_service();
@@ -76987,15 +80573,13 @@
-[section:remote_endpoint seq_packet_socket_service::remote_endpoint]
+[section:id signal_set_service::id]
-[indexterm2 remote_endpoint..seq_packet_socket_service]
-Get the remote endpoint.
+[indexterm2 id..signal_set_service]
+The unique service identifier.
- endpoint_type remote_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+ static boost::asio::io_service::id id;
@@ -77003,52 +80587,36 @@
-[section:send seq_packet_socket_service::send]
-
-[indexterm2 send..seq_packet_socket_service]
-Send the given data to the peer.
-
-
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
-
-
+[section:implementation_type signal_set_service::implementation_type]
-[endsect]
+[indexterm2 implementation_type..signal_set_service]
+The type of a signal set implementation.
+ typedef implementation_defined implementation_type;
-[section:seq_packet_socket_service seq_packet_socket_service::seq_packet_socket_service]
-[indexterm2 seq_packet_socket_service..seq_packet_socket_service]
-Construct a new sequenced packet socket service for the specified [link boost_asio.reference.io_service `io_service`].
+[heading Requirements]
- seq_packet_socket_service(
- boost::asio::io_service & io_service);
+[*Header: ][^boost/asio/signal_set_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:set_option seq_packet_socket_service::set_option]
+[section:remove signal_set_service::remove]
-[indexterm2 set_option..seq_packet_socket_service]
-Set a socket option.
+[indexterm2 remove..signal_set_service]
+Remove a signal to a signal\_set.
- template<
- typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
- boost::system::error_code set_option(
+ boost::system::error_code remove(
implementation_type & impl,
- const SettableSocketOption & option,
+ int signal_number,
boost::system::error_code & ec);
@@ -77057,16 +80625,14 @@
-[section:shutdown seq_packet_socket_service::shutdown]
+[section:signal_set_service signal_set_service::signal_set_service]
-[indexterm2 shutdown..seq_packet_socket_service]
-Disable sends or receives on the socket.
+[indexterm2 signal_set_service..signal_set_service]
+Construct a new signal set service for the specified [link boost_asio.reference.io_service `io_service`].
- boost::system::error_code shutdown(
- implementation_type & impl,
- socket_base::shutdown_type what,
- boost::system::error_code & ec);
+ signal_set_service(
+ boost::asio::io_service & io_service);
@@ -77076,14 +80642,16 @@
[endsect]
+[section:socket_acceptor_service socket_acceptor_service]
-[section:serial_port serial_port]
-[indexterm1 serial_port]
-Typedef for the typical usage of a serial port.
+Default service implementation for a socket acceptor.
- typedef basic_serial_port serial_port;
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class socket_acceptor_service :
+ public io_service::service
[heading Types]
@@ -77092,36 +80660,36 @@
[
- [[link boost_asio.reference.basic_serial_port.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
+ [[link boost_asio.reference.socket_acceptor_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
]
[
- [[link boost_asio.reference.basic_serial_port.lowest_layer_type [*lowest_layer_type]]]
- [A basic_serial_port is always the lowest layer. ]
+ [[link boost_asio.reference.socket_acceptor_service.implementation_type [*implementation_type]]]
+ [The native type of the socket acceptor. ]
]
[
- [[link boost_asio.reference.basic_serial_port.native_handle_type [*native_handle_type]]]
- [The native representation of a serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.native_handle_type [*native_handle_type]]]
+ [The native acceptor type. ]
]
[
- [[link boost_asio.reference.basic_serial_port.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native representation of a serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native acceptor type. ]
]
[
- [[link boost_asio.reference.basic_serial_port.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.socket_acceptor_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
]
@@ -77132,152 +80700,366 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_serial_port.assign [*assign]]]
- [Assign an existing native serial port to the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.accept [*accept]]]
+ [Accept a new connection. ]
]
[
- [[link boost_asio.reference.basic_serial_port.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
+ [[link boost_asio.reference.socket_acceptor_service.assign [*assign]]]
+ [Assign an existing native acceptor to a socket acceptor. ]
]
[
- [[link boost_asio.reference.basic_serial_port.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
+ [[link boost_asio.reference.socket_acceptor_service.async_accept [*async_accept]]]
+ [Start an asynchronous accept. ]
]
[
- [[link boost_asio.reference.basic_serial_port.basic_serial_port [*basic_serial_port]]]
- [Construct a basic_serial_port without opening it.
-
- Construct and open a basic_serial_port.
-
- Construct a basic_serial_port on an existing native serial port.
-
- Move-construct a basic_serial_port from another. ]
+ [[link boost_asio.reference.socket_acceptor_service.bind [*bind]]]
+ [Bind the socket acceptor to the specified local endpoint. ]
]
[
- [[link boost_asio.reference.basic_serial_port.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the acceptor. ]
]
[
- [[link boost_asio.reference.basic_serial_port.close [*close]]]
- [Close the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.close [*close]]]
+ [Close a socket acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.socket_acceptor_service.construct [*construct]]]
+ [Construct a new socket acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.get_option [*get_option]]]
- [Get an option from the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.destroy [*destroy]]]
+ [Destroy a socket acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.is_open [*is_open]]]
- [Determine whether the serial port is open. ]
+ [[link boost_asio.reference.socket_acceptor_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
]
[
- [[link boost_asio.reference.basic_serial_port.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer.
-
- Get a const reference to the lowest layer. ]
+ [[link boost_asio.reference.socket_acceptor_service.get_option [*get_option]]]
+ [Get a socket option. ]
]
[
- [[link boost_asio.reference.basic_serial_port.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native serial port representation. ]
+ [[link boost_asio.reference.socket_acceptor_service.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
]
[
- [[link boost_asio.reference.basic_serial_port.native_handle [*native_handle]]]
- [Get the native serial port representation. ]
+ [[link boost_asio.reference.socket_acceptor_service.is_open [*is_open]]]
+ [Determine whether the acceptor is open. ]
]
[
- [[link boost_asio.reference.basic_serial_port.open [*open]]]
- [Open the serial port using the specified device name. ]
+ [[link boost_asio.reference.socket_acceptor_service.listen [*listen]]]
+ [Place the socket acceptor into the state where it will listen for new connections. ]
]
[
- [[link boost_asio.reference.basic_serial_port.operator_eq_ [*operator=]]]
- [Move-assign a basic_serial_port from another. ]
+ [[link boost_asio.reference.socket_acceptor_service.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint. ]
]
[
- [[link boost_asio.reference.basic_serial_port.read_some [*read_some]]]
- [Read some data from the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.move_assign [*move_assign]]]
+ [Move-assign from another socket acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.send_break [*send_break]]]
- [Send a break sequence to the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.move_construct [*move_construct]]]
+ [Move-construct a new socket acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.set_option [*set_option]]]
- [Set an option on the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native acceptor implementation. ]
]
[
- [[link boost_asio.reference.basic_serial_port.write_some [*write_some]]]
- [Write some data to the serial port. ]
+ [[link boost_asio.reference.socket_acceptor_service.native_handle [*native_handle]]]
+ [Get the native acceptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native acceptor implementation.
+
+ Sets the non-blocking mode of the native acceptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the acceptor.
+
+ Sets the non-blocking mode of the acceptor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.open [*open]]]
+ [Open a new socket acceptor implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.set_option [*set_option]]]
+ [Set a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.socket_acceptor_service [*socket_acceptor_service]]]
+ [Construct a new socket acceptor service for the specified io_service. ]
]
]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.socket_acceptor_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+
+]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:accept socket_acceptor_service::accept]
+
+[indexterm2 accept..socket_acceptor_service]
+Accept a new connection.
+
+
+ template<
+ typename ``[link boost_asio.reference.SocketService SocketService]``>
+ boost::system::error_code accept(
+ implementation_type & impl,
+ basic_socket< protocol_type, SocketService > & peer,
+ endpoint_type * peer_endpoint,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:assign socket_acceptor_service::assign]
+
+[indexterm2 assign..socket_acceptor_service]
+Assign an existing native acceptor to a socket acceptor.
+
+
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ const native_handle_type & native_acceptor,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:async_accept socket_acceptor_service::async_accept]
+
+[indexterm2 async_accept..socket_acceptor_service]
+Start an asynchronous accept.
+
+
+ template<
+ typename ``[link boost_asio.reference.SocketService SocketService]``,
+ typename ``[link boost_asio.reference.AcceptHandler AcceptHandler]``>
+ void async_accept(
+ implementation_type & impl,
+ basic_socket< protocol_type, SocketService > & peer,
+ endpoint_type * peer_endpoint,
+ AcceptHandler handler);
+
+
+
+[endsect]
+
+
+
+[section:bind socket_acceptor_service::bind]
+
+[indexterm2 bind..socket_acceptor_service]
+Bind the socket acceptor to the specified local endpoint.
+
+
+ boost::system::error_code bind(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:cancel socket_acceptor_service::cancel]
+
+[indexterm2 cancel..socket_acceptor_service]
+Cancel all asynchronous operations associated with the acceptor.
+
+
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:close socket_acceptor_service::close]
+
+[indexterm2 close..socket_acceptor_service]
+Close a socket acceptor implementation.
+
+
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:construct socket_acceptor_service::construct]
+
+[indexterm2 construct..socket_acceptor_service]
+Construct a new socket acceptor implementation.
+
+
+ void construct(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:destroy socket_acceptor_service::destroy]
+
+[indexterm2 destroy..socket_acceptor_service]
+Destroy a socket acceptor implementation.
+
+
+ void destroy(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:endpoint_type socket_acceptor_service::endpoint_type]
+
+[indexterm2 endpoint_type..socket_acceptor_service]
+The endpoint type.
+
+
+ typedef protocol_type::endpoint endpoint_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:get_io_service socket_acceptor_service::get_io_service]
+
+
+['Inherited from io_service.]
+
+[indexterm2 get_io_service..socket_acceptor_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+
+
+ boost::asio::io_service & get_io_service();
+
+
+
+[endsect]
+
+
+
+[section:get_option socket_acceptor_service::get_option]
+
+[indexterm2 get_option..socket_acceptor_service]
+Get a socket option.
- [
- [[link boost_asio.reference.basic_serial_port.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
- ]
-
- [
- [[link boost_asio.reference.basic_serial_port.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
- ]
-
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+ template<
+ typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSocketOption & option,
+ boost::system::error_code & ec) const;
- [
- [[link boost_asio.reference.basic_serial_port.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
- ]
- [
- [[link boost_asio.reference.basic_serial_port.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
- ]
-]
+[endsect]
-The [link boost_asio.reference.basic_serial_port `basic_serial_port`] class template provides functionality that is common to all serial ports.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[section:id socket_acceptor_service::id]
+
+[indexterm2 id..socket_acceptor_service]
+The unique service identifier.
+
+
+ static boost::asio::io_service::id id;
+
-[*Shared] [*objects:] Unsafe.
+[endsect]
+
+
+
+[section:implementation_type socket_acceptor_service::implementation_type]
+
+[indexterm2 implementation_type..socket_acceptor_service]
+The native type of the socket acceptor.
+
+
+ typedef implementation_defined implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/serial_port.hpp]
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -77285,140 +81067,115 @@
[endsect]
-[section:serial_port_base serial_port_base]
+[section:io_control socket_acceptor_service::io_control]
-The [link boost_asio.reference.serial_port_base `serial_port_base`] class is used as a base for the [link boost_asio.reference.basic_serial_port `basic_serial_port`] class template so that we have a common place to define the serial port options.
+[indexterm2 io_control..socket_acceptor_service]
+Perform an IO control command on the socket.
- class serial_port_base
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
+ boost::system::error_code & ec);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.serial_port_base__baud_rate [*baud_rate]]]
- [Serial port option to permit changing the baud rate. ]
-
- ]
- [
- [[link boost_asio.reference.serial_port_base__character_size [*character_size]]]
- [Serial port option to permit changing the character size. ]
-
- ]
+[section:is_open socket_acceptor_service::is_open]
- [
+[indexterm2 is_open..socket_acceptor_service]
+Determine whether the acceptor is open.
- [[link boost_asio.reference.serial_port_base__flow_control [*flow_control]]]
- [Serial port option to permit changing the flow control. ]
-
- ]
- [
+ bool is_open(
+ const implementation_type & impl) const;
- [[link boost_asio.reference.serial_port_base__parity [*parity]]]
- [Serial port option to permit changing the parity. ]
-
- ]
- [
- [[link boost_asio.reference.serial_port_base__stop_bits [*stop_bits]]]
- [Serial port option to permit changing the number of stop bits. ]
-
- ]
+[endsect]
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.serial_port_base._serial_port_base [*~serial_port_base]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
-]
+[section:listen socket_acceptor_service::listen]
-[heading Requirements]
+[indexterm2 listen..socket_acceptor_service]
+Place the socket acceptor into the state where it will listen for new connections.
-[*Header: ][^boost/asio/serial_port_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+ boost::system::error_code listen(
+ implementation_type & impl,
+ int backlog,
+ boost::system::error_code & ec);
-[section:_serial_port_base serial_port_base::~serial_port_base]
-[indexterm2 ~serial_port_base..serial_port_base]
-Protected destructor to prevent deletion through this type.
+[endsect]
- ~serial_port_base();
+[section:local_endpoint socket_acceptor_service::local_endpoint]
+
+[indexterm2 local_endpoint..socket_acceptor_service]
+Get the local endpoint.
-[endsect]
+ endpoint_type local_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
[endsect]
-[section:serial_port_base__baud_rate serial_port_base::baud_rate]
-Serial port option to permit changing the baud rate.
+[section:move_assign socket_acceptor_service::move_assign]
+[indexterm2 move_assign..socket_acceptor_service]
+Move-assign from another socket acceptor implementation.
- class baud_rate
+ void move_assign(
+ implementation_type & impl,
+ socket_acceptor_service & other_service,
+ implementation_type & other_impl);
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.serial_port_base__baud_rate.baud_rate [*baud_rate]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__baud_rate.load [*load]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__baud_rate.store [*store]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__baud_rate.value [*value]]]
- []
- ]
-
-]
-Implements changing the baud rate for a given serial port.
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/serial_port_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:move_construct socket_acceptor_service::move_construct]
+[indexterm2 move_construct..socket_acceptor_service]
+Move-construct a new socket acceptor implementation.
-[section:baud_rate serial_port_base::baud_rate::baud_rate]
-[indexterm2 baud_rate..serial_port_base::baud_rate]
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
- baud_rate(
- unsigned int rate = 0);
+
+
+[endsect]
+
+
+
+[section:native socket_acceptor_service::native]
+
+[indexterm2 native..socket_acceptor_service]
+(Deprecated: Use `native_handle()`.) Get the native acceptor implementation.
+
+
+ native_type native(
+ implementation_type & impl);
@@ -77426,13 +81183,14 @@
-[section:load serial_port_base::baud_rate::load]
+[section:native_handle socket_acceptor_service::native_handle]
-[indexterm2 load..serial_port_base::baud_rate]
+[indexterm2 native_handle..socket_acceptor_service]
+Get the native acceptor implementation.
- boost::system::error_code load(
- const BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec);
+
+ native_handle_type native_handle(
+ implementation_type & impl);
@@ -77440,25 +81198,55 @@
-[section:store serial_port_base::baud_rate::store]
+[section:native_handle_type socket_acceptor_service::native_handle_type]
-[indexterm2 store..serial_port_base::baud_rate]
+[indexterm2 native_handle_type..socket_acceptor_service]
+The native acceptor type.
- boost::system::error_code store(
- BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec) const;
+ typedef implementation_defined native_handle_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:native_non_blocking socket_acceptor_service::native_non_blocking]
-[section:value serial_port_base::baud_rate::value]
+[indexterm2 native_non_blocking..socket_acceptor_service]
+Gets the non-blocking mode of the native acceptor implementation.
-[indexterm2 value..serial_port_base::baud_rate]
- unsigned int value() const;
+ bool ``[link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload1 more...]]``
+
+
+Sets the non-blocking mode of the native acceptor implementation.
+
+
+ boost::system::error_code ``[link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload2 more...]]``
+
+
+[section:overload1 socket_acceptor_service::native_non_blocking (1 of 2 overloads)]
+
+
+Gets the non-blocking mode of the native acceptor implementation.
+
+
+ bool native_non_blocking(
+ const implementation_type & impl) const;
@@ -77466,58 +81254,74 @@
+[section:overload2 socket_acceptor_service::native_non_blocking (2 of 2 overloads)]
+
+
+Sets the non-blocking mode of the native acceptor implementation.
+
+
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+
+
+
[endsect]
-[section:serial_port_base__character_size serial_port_base::character_size]
+[endsect]
-Serial port option to permit changing the character size.
+[section:native_type socket_acceptor_service::native_type]
- class character_size
+[indexterm2 native_type..socket_acceptor_service]
+(Deprecated: Use native\_handle\_type.) The native acceptor type.
-[heading Member Functions]
-[table
- [[Name][Description]]
+ typedef implementation_defined native_type;
- [
- [[link boost_asio.reference.serial_port_base__character_size.character_size [*character_size]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__character_size.load [*load]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__character_size.store [*store]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__character_size.value [*value]]]
- []
- ]
-
-]
-Implements changing the character size for a given serial port.
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_base.hpp]
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:character_size serial_port_base::character_size::character_size]
+[endsect]
-[indexterm2 character_size..serial_port_base::character_size]
- character_size(
- unsigned int t = 8);
+[section:non_blocking socket_acceptor_service::non_blocking]
+
+[indexterm2 non_blocking..socket_acceptor_service]
+Gets the non-blocking mode of the acceptor.
+
+
+ bool ``[link boost_asio.reference.socket_acceptor_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.socket_acceptor_service.non_blocking.overload1 more...]]``
+
+
+Sets the non-blocking mode of the acceptor.
+
+
+ boost::system::error_code ``[link boost_asio.reference.socket_acceptor_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.socket_acceptor_service.non_blocking.overload2 more...]]``
+
+
+[section:overload1 socket_acceptor_service::non_blocking (1 of 2 overloads)]
+
+
+Gets the non-blocking mode of the acceptor.
+
+
+ bool non_blocking(
+ const implementation_type & impl) const;
@@ -77525,12 +81329,15 @@
-[section:load serial_port_base::character_size::load]
+[section:overload2 socket_acceptor_service::non_blocking (2 of 2 overloads)]
-[indexterm2 load..serial_port_base::character_size]
- boost::system::error_code load(
- const BOOST_ASIO_OPTION_STORAGE & storage,
+Sets the non-blocking mode of the acceptor.
+
+
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
boost::system::error_code & ec);
@@ -77538,14 +81345,19 @@
[endsect]
+[endsect]
-[section:store serial_port_base::character_size::store]
-[indexterm2 store..serial_port_base::character_size]
+[section:open socket_acceptor_service::open]
- boost::system::error_code store(
- BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec) const;
+[indexterm2 open..socket_acceptor_service]
+Open a new socket acceptor implementation.
+
+
+ boost::system::error_code open(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ boost::system::error_code & ec);
@@ -77553,11 +81365,39 @@
-[section:value serial_port_base::character_size::value]
+[section:protocol_type socket_acceptor_service::protocol_type]
-[indexterm2 value..serial_port_base::character_size]
+[indexterm2 protocol_type..socket_acceptor_service]
+The protocol type.
- unsigned int value() const;
+
+ typedef Protocol protocol_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/socket_acceptor_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:set_option socket_acceptor_service::set_option]
+
+[indexterm2 set_option..socket_acceptor_service]
+Set a socket option.
+
+
+ template<
+ typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSocketOption & option,
+ boost::system::error_code & ec);
@@ -77565,15 +81405,30 @@
+[section:socket_acceptor_service socket_acceptor_service::socket_acceptor_service]
+
+[indexterm2 socket_acceptor_service..socket_acceptor_service]
+Construct a new socket acceptor service for the specified [link boost_asio.reference.io_service `io_service`].
+
+
+ socket_acceptor_service(
+ boost::asio::io_service & io_service);
+
+
+
[endsect]
-[section:serial_port_base__flow_control serial_port_base::flow_control]
-Serial port option to permit changing the flow control.
+[endsect]
+
+[section:socket_base socket_base]
- class flow_control
+The [link boost_asio.reference.socket_base `socket_base`] class is used as a base for the [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] and [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class templates so that we have a common place to define the shutdown\_type and enum.
+
+
+ class socket_base
[heading Types]
@@ -77582,662 +81437,514 @@
[
- [[link boost_asio.reference.serial_port_base__flow_control.type [*type]]]
- []
+ [[link boost_asio.reference.socket_base.broadcast [*broadcast]]]
+ [Socket option to permit sending of broadcast messages. ]
]
-]
-
-[heading Member Functions]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.serial_port_base__flow_control.flow_control [*flow_control]]]
- []
- ]
+
+ [[link boost_asio.reference.socket_base.bytes_readable [*bytes_readable]]]
+ [IO control command to get the amount of data that can be read without blocking. ]
- [
- [[link boost_asio.reference.serial_port_base__flow_control.load [*load]]]
- []
]
-
+
[
- [[link boost_asio.reference.serial_port_base__flow_control.store [*store]]]
- []
- ]
+
+ [[link boost_asio.reference.socket_base.debug [*debug]]]
+ [Socket option to enable socket-level debugging. ]
- [
- [[link boost_asio.reference.serial_port_base__flow_control.value [*value]]]
- []
]
-
-]
-
-Implements changing the flow control for a given serial port.
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/serial_port_base.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
+ [
-[section:flow_control serial_port_base::flow_control::flow_control]
+ [[link boost_asio.reference.socket_base.do_not_route [*do_not_route]]]
+ [Socket option to prevent routing, use local interfaces only. ]
+
+ ]
-[indexterm2 flow_control..serial_port_base::flow_control]
+ [
- flow_control(
- type t = none);
+ [[link boost_asio.reference.socket_base.enable_connection_aborted [*enable_connection_aborted]]]
+ [Socket option to report aborted connections on accept. ]
+
+ ]
+ [
+ [[link boost_asio.reference.socket_base.keep_alive [*keep_alive]]]
+ [Socket option to send keep-alives. ]
+
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.socket_base.linger [*linger]]]
+ [Socket option to specify whether the socket lingers on close if unsent data is present. ]
+
+ ]
+ [
-[section:load serial_port_base::flow_control::load]
+ [[link boost_asio.reference.socket_base.message_flags [*message_flags]]]
+ [Bitmask type for flags that can be passed to send and receive operations. ]
+
+ ]
-[indexterm2 load..serial_port_base::flow_control]
+ [
- boost::system::error_code load(
- const BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec);
+ [[link boost_asio.reference.socket_base.non_blocking_io [*non_blocking_io]]]
+ [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
+
+ ]
+ [
+ [[link boost_asio.reference.socket_base.receive_buffer_size [*receive_buffer_size]]]
+ [Socket option for the receive buffer size of a socket. ]
+
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.socket_base.receive_low_watermark [*receive_low_watermark]]]
+ [Socket option for the receive low watermark. ]
+
+ ]
+ [
-[section:store serial_port_base::flow_control::store]
+ [[link boost_asio.reference.socket_base.reuse_address [*reuse_address]]]
+ [Socket option to allow the socket to be bound to an address that is already in use. ]
+
+ ]
-[indexterm2 store..serial_port_base::flow_control]
+ [
- boost::system::error_code store(
- BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec) const;
+ [[link boost_asio.reference.socket_base.send_buffer_size [*send_buffer_size]]]
+ [Socket option for the send buffer size of a socket. ]
+
+ ]
+ [
+ [[link boost_asio.reference.socket_base.send_low_watermark [*send_low_watermark]]]
+ [Socket option for the send low watermark. ]
+
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.socket_base.shutdown_type [*shutdown_type]]]
+ [Different ways a socket may be shutdown. ]
+
+ ]
+]
-[section:type serial_port_base::flow_control::type]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[indexterm2 type..serial_port_base::flow_control]
+ [
+ [[link boost_asio.reference.socket_base._socket_base [*~socket_base]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
+]
- enum type
+[heading Data Members]
+[table
+ [[Name][Description]]
-[indexterm2 none..serial_port_base::flow_control]
-[indexterm2 software..serial_port_base::flow_control]
-[indexterm2 hardware..serial_port_base::flow_control]
+ [
+ [[link boost_asio.reference.socket_base.max_connections [*max_connections]]]
+ [The maximum length of the queue of pending incoming connections. ]
+ ]
-[heading Values]
-[variablelist
+ [
+ [[link boost_asio.reference.socket_base.message_do_not_route [*message_do_not_route]]]
+ [Specify that the data should not be subject to routing. ]
+ ]
[
- [none]
- []
+ [[link boost_asio.reference.socket_base.message_end_of_record [*message_end_of_record]]]
+ [Specifies that the data marks the end of a record. ]
]
[
- [software]
- []
+ [[link boost_asio.reference.socket_base.message_out_of_band [*message_out_of_band]]]
+ [Process out-of-band data. ]
]
[
- [hardware]
- []
+ [[link boost_asio.reference.socket_base.message_peek [*message_peek]]]
+ [Peek at incoming data without removing it from the input queue. ]
]
]
+[heading Requirements]
+[*Header: ][^boost/asio/socket_base.hpp]
-[endsect]
-
+[*Convenience header: ][^boost/asio.hpp]
-[section:value serial_port_base::flow_control::value]
+[section:broadcast socket_base::broadcast]
-[indexterm2 value..serial_port_base::flow_control]
+[indexterm2 broadcast..socket_base]
+Socket option to permit sending of broadcast messages.
- type value() const;
+ typedef implementation_defined broadcast;
-[endsect]
+Implements the SOL\_SOCKET/SO\_BROADCAST socket option.
-[endsect]
+[heading Examples]
+
+Setting the option:
-[section:serial_port_base__parity serial_port_base::parity]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::broadcast option(true);
+ socket.set_option(option);
-Serial port option to permit changing the parity.
- class parity
+Getting the current option value:
-[heading Types]
-[table
- [[Name][Description]]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::broadcast option;
+ socket.get_option(option);
+ bool is_set = option.value();
- [
- [[link boost_asio.reference.serial_port_base__parity.type [*type]]]
- []
-
- ]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.serial_port_base__parity.load [*load]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__parity.parity [*parity]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__parity.store [*store]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__parity.value [*value]]]
- []
- ]
-
-]
-Implements changing the parity for a given serial port.
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_base.hpp]
+[*Header: ][^boost/asio/socket_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:load serial_port_base::parity::load]
+[endsect]
-[indexterm2 load..serial_port_base::parity]
- boost::system::error_code load(
- const BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec);
+[section:bytes_readable socket_base::bytes_readable]
+[indexterm2 bytes_readable..socket_base]
+IO control command to get the amount of data that can be read without blocking.
-[endsect]
+ typedef implementation_defined bytes_readable;
-[section:parity serial_port_base::parity::parity]
-[indexterm2 parity..serial_port_base::parity]
+Implements the FIONREAD IO control command.
- parity(
- type t = none);
+[heading Example]
+
-[endsect]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::bytes_readable command(true);
+ socket.io_control(command);
+ std::size_t bytes_readable = command.get();
-[section:store serial_port_base::parity::store]
-[indexterm2 store..serial_port_base::parity]
- boost::system::error_code store(
- BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec) const;
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/socket_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:type serial_port_base::parity::type]
+[endsect]
-[indexterm2 type..serial_port_base::parity]
- enum type
-[indexterm2 none..serial_port_base::parity]
-[indexterm2 odd..serial_port_base::parity]
-[indexterm2 even..serial_port_base::parity]
+[section:debug socket_base::debug]
-[heading Values]
-[variablelist
+[indexterm2 debug..socket_base]
+Socket option to enable socket-level debugging.
- [
- [none]
- []
- ]
- [
- [odd]
- []
- ]
+ typedef implementation_defined debug;
- [
- [even]
- []
- ]
-]
+Implements the SOL\_SOCKET/SO\_DEBUG socket option.
-[endsect]
+[heading Examples]
+
+Setting the option:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::debug option(true);
+ socket.set_option(option);
-[section:value serial_port_base::parity::value]
-[indexterm2 value..serial_port_base::parity]
- type value() const;
+Getting the current option value:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::debug option;
+ socket.get_option(option);
+ bool is_set = option.value();
-[endsect]
-[endsect]
-[section:serial_port_base__stop_bits serial_port_base::stop_bits]
-Serial port option to permit changing the number of stop bits.
+[heading Requirements]
+[*Header: ][^boost/asio/socket_base.hpp]
- class stop_bits
+[*Convenience header: ][^boost/asio.hpp]
-[heading Types]
-[table
- [[Name][Description]]
+[endsect]
- [
- [[link boost_asio.reference.serial_port_base__stop_bits.type [*type]]]
- []
-
- ]
-]
+[section:do_not_route socket_base::do_not_route]
-[heading Member Functions]
-[table
- [[Name][Description]]
+[indexterm2 do_not_route..socket_base]
+Socket option to prevent routing, use local interfaces only.
- [
- [[link boost_asio.reference.serial_port_base__stop_bits.load [*load]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__stop_bits.stop_bits [*stop_bits]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__stop_bits.store [*store]]]
- []
- ]
-
- [
- [[link boost_asio.reference.serial_port_base__stop_bits.value [*value]]]
- []
- ]
-
-]
-Implements changing the number of stop bits for a given serial port.
+ typedef implementation_defined do_not_route;
-[heading Requirements]
-[*Header: ][^boost/asio/serial_port_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+Implements the SOL\_SOCKET/SO\_DONTROUTE socket option.
-[section:load serial_port_base::stop_bits::load]
+[heading Examples]
+
+Setting the option:
-[indexterm2 load..serial_port_base::stop_bits]
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::do_not_route option(true);
+ socket.set_option(option);
- boost::system::error_code load(
- const BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec);
-[endsect]
+Getting the current option value:
+ boost::asio::ip::udp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::do_not_route option;
+ socket.get_option(option);
+ bool is_set = option.value();
-[section:stop_bits serial_port_base::stop_bits::stop_bits]
-[indexterm2 stop_bits..serial_port_base::stop_bits]
- stop_bits(
- type t = one);
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/socket_base.hpp]
-[section:store serial_port_base::stop_bits::store]
+[*Convenience header: ][^boost/asio.hpp]
-[indexterm2 store..serial_port_base::stop_bits]
- boost::system::error_code store(
- BOOST_ASIO_OPTION_STORAGE & storage,
- boost::system::error_code & ec) const;
+[endsect]
-[endsect]
+[section:enable_connection_aborted socket_base::enable_connection_aborted]
+[indexterm2 enable_connection_aborted..socket_base]
+Socket option to report aborted connections on accept.
-[section:type serial_port_base::stop_bits::type]
+ typedef implementation_defined enable_connection_aborted;
-[indexterm2 type..serial_port_base::stop_bits]
- enum type
-[indexterm2 one..serial_port_base::stop_bits]
-[indexterm2 onepointfive..serial_port_base::stop_bits]
-[indexterm2 two..serial_port_base::stop_bits]
+Implements a custom socket option that determines whether or not an accept operation is permitted to fail with `boost::asio::error::connection_aborted`. By default the option is false.
-[heading Values]
-[variablelist
- [
- [one]
- []
- ]
+[heading Examples]
+
+Setting the option:
- [
- [onepointfive]
- []
- ]
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ ...
+ boost::asio::socket_base::enable_connection_aborted option(true);
+ acceptor.set_option(option);
- [
- [two]
- []
- ]
-]
-[endsect]
+Getting the current option value:
+
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ ...
+ boost::asio::socket_base::enable_connection_aborted option;
+ acceptor.get_option(option);
+ bool is_set = option.value();
-[section:value serial_port_base::stop_bits::value]
-[indexterm2 value..serial_port_base::stop_bits]
- type value() const;
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/socket_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:serial_port_service serial_port_service]
-Default service implementation for a serial port.
+[section:keep_alive socket_base::keep_alive]
+[indexterm2 keep_alive..socket_base]
+Socket option to send keep-alives.
- class serial_port_service :
- public io_service::service
+ typedef implementation_defined keep_alive;
-[heading Types]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.serial_port_service.implementation_type [*implementation_type]]]
- [The type of a serial port implementation. ]
-
- ]
+Implements the SOL\_SOCKET/SO\_KEEPALIVE socket option.
- [
- [[link boost_asio.reference.serial_port_service.native_handle_type [*native_handle_type]]]
- [The native handle type. ]
+[heading Examples]
- ]
+Setting the option:
- [
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::keep_alive option(true);
+ socket.set_option(option);
- [[link boost_asio.reference.serial_port_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native handle type. ]
-
- ]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.serial_port_service.assign [*assign]]]
- [Assign an existing native handle to a serial port. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the handle. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.close [*close]]]
- [Close a serial port implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.construct [*construct]]]
- [Construct a new serial port implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.destroy [*destroy]]]
- [Destroy a serial port implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.get_option [*get_option]]]
- [Get a serial port option. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.is_open [*is_open]]]
- [Determine whether the handle is open. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.move_assign [*move_assign]]]
- [Move-assign from another serial port implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.move_construct [*move_construct]]]
- [Move-construct a new serial port implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native handle implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.native_handle [*native_handle]]]
- [Get the native handle implementation. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.open [*open]]]
- [Open a serial port. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.read_some [*read_some]]]
- [Read some data from the stream. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.send_break [*send_break]]]
- [Send a break sequence to the serial port. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.serial_port_service [*serial_port_service]]]
- [Construct a new serial port service for the specified io_service. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.set_option [*set_option]]]
- [Set a serial port option. ]
- ]
-
- [
- [[link boost_asio.reference.serial_port_service.write_some [*write_some]]]
- [Write the given data to the stream. ]
- ]
-
-]
-[heading Data Members]
-[table
- [[Name][Description]]
+Getting the current option value:
+
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::keep_alive option;
+ socket.get_option(option);
+ bool is_set = option.value();
+
+
+
+
- [
- [[link boost_asio.reference.serial_port_service.id [*id]]]
- [The unique service identifier. ]
- ]
-]
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_service.hpp]
+[*Header: ][^boost/asio/socket_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:assign serial_port_service::assign]
+[endsect]
+
+
+
+[section:linger socket_base::linger]
+
+[indexterm2 linger..socket_base]
+Socket option to specify whether the socket lingers on close if unsent data is present.
+
-[indexterm2 assign..serial_port_service]
-Assign an existing native handle to a serial port.
+ typedef implementation_defined linger;
- boost::system::error_code assign(
- implementation_type & impl,
- const native_handle_type & handle,
- boost::system::error_code & ec);
+Implements the SOL\_SOCKET/SO\_LINGER socket option.
-[endsect]
+[heading Examples]
+
+Setting the option:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::linger option(true, 30);
+ socket.set_option(option);
-[section:async_read_some serial_port_service::async_read_some]
-[indexterm2 async_read_some..serial_port_service]
-Start an asynchronous read.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- ReadHandler handler);
+Getting the current option value:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::linger option;
+ socket.get_option(option);
+ bool is_set = option.enabled();
+ unsigned short timeout = option.timeout();
-[endsect]
-[section:async_write_some serial_port_service::async_write_some]
-[indexterm2 async_write_some..serial_port_service]
-Start an asynchronous write.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- WriteHandler handler);
+[*Header: ][^boost/asio/socket_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:cancel serial_port_service::cancel]
+[section:max_connections socket_base::max_connections]
-[indexterm2 cancel..serial_port_service]
-Cancel all asynchronous operations associated with the handle.
+[indexterm2 max_connections..socket_base]
+The maximum length of the queue of pending incoming connections.
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+ static const int max_connections = implementation_defined;
@@ -78245,15 +81952,13 @@
-[section:close serial_port_service::close]
+[section:message_do_not_route socket_base::message_do_not_route]
-[indexterm2 close..serial_port_service]
-Close a serial port implementation.
+[indexterm2 message_do_not_route..socket_base]
+Specify that the data should not be subject to routing.
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
+ static const int message_do_not_route = implementation_defined;
@@ -78261,14 +81966,13 @@
-[section:construct serial_port_service::construct]
+[section:message_end_of_record socket_base::message_end_of_record]
-[indexterm2 construct..serial_port_service]
-Construct a new serial port implementation.
+[indexterm2 message_end_of_record..socket_base]
+Specifies that the data marks the end of a record.
- void construct(
- implementation_type & impl);
+ static const int message_end_of_record = implementation_defined;
@@ -78276,31 +81980,34 @@
-[section:destroy serial_port_service::destroy]
+[section:message_flags socket_base::message_flags]
-[indexterm2 destroy..serial_port_service]
-Destroy a serial port implementation.
+[indexterm2 message_flags..socket_base]
+Bitmask type for flags that can be passed to send and receive operations.
- void destroy(
- implementation_type & impl);
+ typedef int message_flags;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/socket_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:get_io_service serial_port_service::get_io_service]
+[endsect]
-['Inherited from io_service.]
-[indexterm2 get_io_service..serial_port_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[section:message_out_of_band socket_base::message_out_of_band]
- boost::asio::io_service & get_io_service();
+[indexterm2 message_out_of_band..socket_base]
+Process out-of-band data.
+
+
+ static const int message_out_of_band = implementation_defined;
@@ -78308,18 +82015,13 @@
-[section:get_option serial_port_service::get_option]
+[section:message_peek socket_base::message_peek]
-[indexterm2 get_option..serial_port_service]
-Get a serial port option.
+[indexterm2 message_peek..socket_base]
+Peek at incoming data without removing it from the input queue.
- template<
- typename ``[link boost_asio.reference.GettableSerialPortOption GettableSerialPortOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSerialPortOption & option,
- boost::system::error_code & ec) const;
+ static const int message_peek = implementation_defined;
@@ -78327,33 +82029,37 @@
-[section:id serial_port_service::id]
+[section:non_blocking_io socket_base::non_blocking_io]
-[indexterm2 id..serial_port_service]
-The unique service identifier.
+[indexterm2 non_blocking_io..socket_base]
+(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the socket.
- static boost::asio::io_service::id id;
+ typedef implementation_defined non_blocking_io;
-[endsect]
+Implements the FIONBIO IO control command.
+
+[heading Example]
+
-[section:implementation_type serial_port_service::implementation_type]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::non_blocking_io command(true);
+ socket.io_control(command);
+
-[indexterm2 implementation_type..serial_port_service]
-The type of a serial port implementation.
- typedef implementation_defined implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_service.hpp]
+[*Header: ][^boost/asio/socket_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -78362,97 +82068,100 @@
-[section:is_open serial_port_service::is_open]
+[section:receive_buffer_size socket_base::receive_buffer_size]
-[indexterm2 is_open..serial_port_service]
-Determine whether the handle is open.
+[indexterm2 receive_buffer_size..socket_base]
+Socket option for the receive buffer size of a socket.
- bool is_open(
- const implementation_type & impl) const;
+ typedef implementation_defined receive_buffer_size;
-[endsect]
+Implements the SOL\_SOCKET/SO\_RCVBUF socket option.
+[heading Examples]
+
+Setting the option:
-[section:move_assign serial_port_service::move_assign]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::receive_buffer_size option(8192);
+ socket.set_option(option);
-[indexterm2 move_assign..serial_port_service]
-Move-assign from another serial port implementation.
- void move_assign(
- implementation_type & impl,
- serial_port_service & other_service,
- implementation_type & other_impl);
+Getting the current option value:
-[endsect]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::receive_buffer_size option;
+ socket.get_option(option);
+ int size = option.value();
-[section:move_construct serial_port_service::move_construct]
-[indexterm2 move_construct..serial_port_service]
-Move-construct a new serial port implementation.
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+[heading Requirements]
+[*Header: ][^boost/asio/socket_base.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:native serial_port_service::native]
-[indexterm2 native..serial_port_service]
-(Deprecated: Use `native_handle()`.) Get the native handle implementation.
+[section:receive_low_watermark socket_base::receive_low_watermark]
- native_type native(
- implementation_type & impl);
+[indexterm2 receive_low_watermark..socket_base]
+Socket option for the receive low watermark.
+ typedef implementation_defined receive_low_watermark;
-[endsect]
+Implements the SOL\_SOCKET/SO\_RCVLOWAT socket option.
-[section:native_handle serial_port_service::native_handle]
-[indexterm2 native_handle..serial_port_service]
-Get the native handle implementation.
+[heading Examples]
+
+Setting the option:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::receive_low_watermark option(1024);
+ socket.set_option(option);
- native_handle_type native_handle(
- implementation_type & impl);
-[endsect]
+Getting the current option value:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::receive_low_watermark option;
+ socket.get_option(option);
+ int size = option.value();
-[section:native_handle_type serial_port_service::native_handle_type]
-[indexterm2 native_handle_type..serial_port_service]
-The native handle type.
- typedef implementation_defined native_handle_type;
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_service.hpp]
+[*Header: ][^boost/asio/socket_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -78461,19 +82170,49 @@
-[section:native_type serial_port_service::native_type]
+[section:reuse_address socket_base::reuse_address]
+
+[indexterm2 reuse_address..socket_base]
+Socket option to allow the socket to be bound to an address that is already in use.
+
+
+ typedef implementation_defined reuse_address;
+
+
+
+Implements the SOL\_SOCKET/SO\_REUSEADDR socket option.
+
+
+[heading Examples]
+
+Setting the option:
+
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ ...
+ boost::asio::socket_base::reuse_address option(true);
+ acceptor.set_option(option);
+
+
+
+
+
+Getting the current option value:
+
+ boost::asio::ip::tcp::acceptor acceptor(io_service);
+ ...
+ boost::asio::socket_base::reuse_address option;
+ acceptor.get_option(option);
+ bool is_set = option.value();
+
-[indexterm2 native_type..serial_port_service]
-(Deprecated: Use native\_handle\_type.) The native handle type.
- typedef implementation_defined native_type;
[heading Requirements]
-[*Header: ][^boost/asio/serial_port_service.hpp]
+[*Header: ][^boost/asio/socket_base.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -78482,145 +82221,153 @@
-[section:open serial_port_service::open]
+[section:send_buffer_size socket_base::send_buffer_size]
-[indexterm2 open..serial_port_service]
-Open a serial port.
+[indexterm2 send_buffer_size..socket_base]
+Socket option for the send buffer size of a socket.
- boost::system::error_code open(
- implementation_type & impl,
- const std::string & device,
- boost::system::error_code & ec);
+ typedef implementation_defined send_buffer_size;
-[endsect]
+Implements the SOL\_SOCKET/SO\_SNDBUF socket option.
+[heading Examples]
+
+Setting the option:
-[section:read_some serial_port_service::read_some]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::send_buffer_size option(8192);
+ socket.set_option(option);
-[indexterm2 read_some..serial_port_service]
-Read some data from the stream.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
+Getting the current option value:
-[endsect]
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::send_buffer_size option;
+ socket.get_option(option);
+ int size = option.value();
-[section:send_break serial_port_service::send_break]
-[indexterm2 send_break..serial_port_service]
-Send a break sequence to the serial port.
- boost::system::error_code send_break(
- implementation_type & impl,
- boost::system::error_code & ec);
+[heading Requirements]
+
+[*Header: ][^boost/asio/socket_base.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:serial_port_service serial_port_service::serial_port_service]
+[section:send_low_watermark socket_base::send_low_watermark]
-[indexterm2 serial_port_service..serial_port_service]
-Construct a new serial port service for the specified [link boost_asio.reference.io_service `io_service`].
+[indexterm2 send_low_watermark..socket_base]
+Socket option for the send low watermark.
- serial_port_service(
- boost::asio::io_service & io_service);
+ typedef implementation_defined send_low_watermark;
-[endsect]
+Implements the SOL\_SOCKET/SO\_SNDLOWAT socket option.
+
+
+[heading Examples]
+
+Setting the option:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::send_low_watermark option(1024);
+ socket.set_option(option);
-[section:set_option serial_port_service::set_option]
-[indexterm2 set_option..serial_port_service]
-Set a serial port option.
- template<
- typename ``[link boost_asio.reference.SettableSerialPortOption SettableSerialPortOption]``>
- boost::system::error_code set_option(
- implementation_type & impl,
- const SettableSerialPortOption & option,
- boost::system::error_code & ec);
+Getting the current option value:
+ boost::asio::ip::tcp::socket socket(io_service);
+ ...
+ boost::asio::socket_base::send_low_watermark option;
+ socket.get_option(option);
+ int size = option.value();
-[endsect]
-[section:write_some serial_port_service::write_some]
-[indexterm2 write_some..serial_port_service]
-Write the given data to the stream.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
+[*Header: ][^boost/asio/socket_base.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
+[section:shutdown_type socket_base::shutdown_type]
-[section:service_already_exists service_already_exists]
+[indexterm2 shutdown_type..socket_base]
+Different ways a socket may be shutdown.
-Exception thrown when trying to add a duplicate service to an [link boost_asio.reference.io_service `io_service`].
+ enum shutdown_type
+[indexterm2 shutdown_receive..socket_base]
+[indexterm2 shutdown_send..socket_base]
+[indexterm2 shutdown_both..socket_base]
- class service_already_exists
+[heading Values]
+[variablelist
+ [
+ [shutdown_receive]
+ [Shutdown the receive side of the socket. ]
+ ]
-[heading Member Functions]
-[table
- [[Name][Description]]
+ [
+ [shutdown_send]
+ [Shutdown the send side of the socket. ]
+ ]
[
- [[link boost_asio.reference.service_already_exists.service_already_exists [*service_already_exists]]]
- []
+ [shutdown_both]
+ [Shutdown both send and receive on the socket. ]
]
-
+
]
-[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[section:service_already_exists service_already_exists::service_already_exists]
-[indexterm2 service_already_exists..service_already_exists]
+[section:_socket_base socket_base::~socket_base]
+
+[indexterm2 ~socket_base..socket_base]
+Protected destructor to prevent deletion through this type.
- service_already_exists();
+
+ ~socket_base();
@@ -78630,14 +82377,13 @@
[endsect]
+[section:ssl__context ssl::context]
-[section:signal_set signal_set]
-
-[indexterm1 signal_set]
-Typedef for the typical usage of a signal set.
- typedef basic_signal_set signal_set;
+ class context :
+ public ssl::context_base,
+ noncopyable
[heading Types]
@@ -78646,15 +82392,43 @@
[
- [[link boost_asio.reference.basic_signal_set.implementation_type [*implementation_type]]]
- [The underlying implementation type of I/O object. ]
+ [[link boost_asio.reference.ssl__context.file_format [*file_format]]]
+ [File format types. ]
]
[
- [[link boost_asio.reference.basic_signal_set.service_type [*service_type]]]
- [The type of the service that will be used to provide I/O operations. ]
+ [[link boost_asio.reference.ssl__context.impl_type [*impl_type]]]
+ [(Deprecated: Use native_handle_type.) The native type of the SSL context. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ssl__context.method [*method]]]
+ [Different methods supported by a context. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ssl__context.native_handle_type [*native_handle_type]]]
+ [The native handle type of the SSL context. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ssl__context.options [*options]]]
+ [Bitmask type for SSL options. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.ssl__context.password_purpose [*password_purpose]]]
+ [Purpose of PEM password. ]
]
@@ -78665,271 +82439,267 @@
[[Name][Description]]
[
- [[link boost_asio.reference.basic_signal_set.add [*add]]]
- [Add a signal to a signal_set. ]
+ [[link boost_asio.reference.ssl__context.add_verify_path [*add_verify_path]]]
+ [Add a directory containing certificate authority files to be used for performing verification. ]
]
[
- [[link boost_asio.reference.basic_signal_set.async_wait [*async_wait]]]
- [Start an asynchronous operation to wait for a signal to be delivered. ]
+ [[link boost_asio.reference.ssl__context.context [*context]]]
+ [Constructor.
+
+ Deprecated constructor taking a reference to an io_service object.
+
+ Move-construct a context from another. ]
]
[
- [[link boost_asio.reference.basic_signal_set.basic_signal_set [*basic_signal_set]]]
- [Construct a signal set without adding any signals.
-
- Construct a signal set and add one signal.
-
- Construct a signal set and add two signals.
-
- Construct a signal set and add three signals. ]
+ [[link boost_asio.reference.ssl__context.impl [*impl]]]
+ [(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.load_verify_file [*load_verify_file]]]
+ [Load a certification authority file for performing verification. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.native_handle [*native_handle]]]
+ [Get the underlying implementation in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.operator_eq_ [*operator=]]]
+ [Move-assign a context from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.set_default_verify_paths [*set_default_verify_paths]]]
+ [Configures the context to use the default directories for finding certification authority certificates. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.set_options [*set_options]]]
+ [Set options on the context. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.set_password_callback [*set_password_callback]]]
+ [Set the password callback. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.set_verify_callback [*set_verify_callback]]]
+ [Set the callback used to verify peer certificates. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.set_verify_mode [*set_verify_mode]]]
+ [Set the peer verification mode. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.use_certificate_chain_file [*use_certificate_chain_file]]]
+ [Use a certificate chain from a file. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__context.use_certificate_file [*use_certificate_file]]]
+ [Use a certificate from a file. ]
]
[
- [[link boost_asio.reference.basic_signal_set.cancel [*cancel]]]
- [Cancel all operations associated with the signal set. ]
+ [[link boost_asio.reference.ssl__context.use_private_key_file [*use_private_key_file]]]
+ [Use a private key from a file. ]
]
[
- [[link boost_asio.reference.basic_signal_set.clear [*clear]]]
- [Remove all signals from a signal_set. ]
+ [[link boost_asio.reference.ssl__context.use_rsa_private_key_file [*use_rsa_private_key_file]]]
+ [Use an RSA private key from a file. ]
]
[
- [[link boost_asio.reference.basic_signal_set.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
+ [[link boost_asio.reference.ssl__context.use_tmp_dh_file [*use_tmp_dh_file]]]
+ [Use the specified file to obtain the temporary Diffie-Hellman parameters. ]
]
[
- [[link boost_asio.reference.basic_signal_set.remove [*remove]]]
- [Remove a signal from a signal_set. ]
+ [[link boost_asio.reference.ssl__context._context [*~context]]]
+ [Destructor. ]
]
]
-[heading Protected Member Functions]
+[heading Data Members]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.basic_signal_set.get_implementation [*get_implementation]]]
- [Get the underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.ssl__context.default_workarounds [*default_workarounds]]]
+ [Implement various bug workarounds. ]
]
-
+
[
- [[link boost_asio.reference.basic_signal_set.get_service [*get_service]]]
- [Get the service associated with the I/O object. ]
+ [[link boost_asio.reference.ssl__context.no_sslv2 [*no_sslv2]]]
+ [Disable SSL v2. ]
]
-
-]
-[heading Protected Data Members]
-[table
- [[Name][Description]]
+ [
+ [[link boost_asio.reference.ssl__context.no_sslv3 [*no_sslv3]]]
+ [Disable SSL v3. ]
+ ]
[
- [[link boost_asio.reference.basic_signal_set.implementation [*implementation]]]
- [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ [[link boost_asio.reference.ssl__context.no_tlsv1 [*no_tlsv1]]]
+ [Disable TLS v1. ]
]
[
- [[link boost_asio.reference.basic_signal_set.service [*service]]]
- [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ [[link boost_asio.reference.ssl__context.single_dh_use [*single_dh_use]]]
+ [Always create a new key when using tmp_dh parameters. ]
]
]
-The [link boost_asio.reference.basic_signal_set `basic_signal_set`] class template provides the ability to perform an asynchronous wait for one or more signals to occur.
-
-Most applications will use the [link boost_asio.reference.signal_set `signal_set`] typedef.
-
+[heading Requirements]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[*Header: ][^boost/asio/ssl/context.hpp]
-[*Shared] [*objects:] Unsafe.
+[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:add_verify_path ssl::context::add_verify_path]
-[heading Example]
-
-Performing an asynchronous wait:
+[indexterm2 add_verify_path..ssl::context]
+Add a directory containing certificate authority files to be used for performing verification.
- void handler(
- const boost::system::error_code& error,
- int signal_number)
- {
- if (!error)
- {
- // A signal occurred.
- }
- }
- ...
+ void ``[link boost_asio.reference.ssl__context.add_verify_path.overload1 add_verify_path]``(
+ const std::string & path);
+ `` [''''»''' [link boost_asio.reference.ssl__context.add_verify_path.overload1 more...]]``
- // Construct a signal set registered for process termination.
- boost::asio::signal_set signals(io_service, SIGINT, SIGTERM);
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.add_verify_path.overload2 add_verify_path]``(
+ const std::string & path,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.add_verify_path.overload2 more...]]``
- // Start an asynchronous wait for one of the signals to occur.
- signals.async_wait(handler);
+[section:overload1 ssl::context::add_verify_path (1 of 2 overloads)]
+Add a directory containing certificate authority files to be used for performing verification.
-[heading Queueing of signal notifications]
-
+ void add_verify_path(
+ const std::string & path);
-If a signal is registered with a signal\_set, and the signal occurs when there are no waiting handlers, then the signal notification is queued. The next async\_wait operation on that signal\_set will dequeue the notification. If multiple notifications are queued, subsequent async\_wait operations dequeue them one at a time. Signal notifications are dequeued in order of ascending signal number.
+This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".
-If a signal number is removed from a signal\_set (using the `remove` or `erase` member functions) then any queued notifications for that signal are discarded.
+[heading Parameters]
+
-[heading Multiple registration of signals]
+[variablelist
+[[path][The name of a directory containing the certificates.]]
+]
-The same signal number may be registered with different signal\_set objects. When the signal occurs, one handler is called for each signal\_set object.
-
-Note that multiple registration only works for signals that are registered using Asio. The application must not also register a signal handler using functions such as `signal()` or `sigaction()`.
+[heading Exceptions]
+
-[heading Signal masking on POSIX platforms]
+[variablelist
+[[boost::system::system_error][Thrown on failure.]]
-
-POSIX allows signals to be blocked using functions such as `sigprocmask()` and `pthread_sigmask()`. For signals to be delivered, programs must ensure that any signals registered using signal\_set objects are unblocked in at least one thread.
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_load_verify_locations`.
-[*Header: ][^boost/asio/signal_set.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:signal_set_service signal_set_service]
+[section:overload2 ssl::context::add_verify_path (2 of 2 overloads)]
-Default service implementation for a signal set.
+Add a directory containing certificate authority files to be used for performing verification.
- class signal_set_service :
- public io_service::service
+ boost::system::error_code add_verify_path(
+ const std::string & path,
+ boost::system::error_code & ec);
-[heading Types]
-[table
- [[Name][Description]]
- [
+This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".
- [[link boost_asio.reference.signal_set_service.implementation_type [*implementation_type]]]
- [The type of a signal set implementation. ]
+
+[heading Parameters]
+
+
+[variablelist
- ]
+[[path][The name of a directory containing the certificates.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.signal_set_service.add [*add]]]
- [Add a signal to a signal_set. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.async_wait [*async_wait]]]
- []
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.cancel [*cancel]]]
- [Cancel all operations associated with the signal set. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.clear [*clear]]]
- [Remove all signals from a signal_set. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.construct [*construct]]]
- [Construct a new signal set implementation. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.destroy [*destroy]]]
- [Destroy a signal set implementation. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.remove [*remove]]]
- [Remove a signal to a signal_set. ]
- ]
-
- [
- [[link boost_asio.reference.signal_set_service.signal_set_service [*signal_set_service]]]
- [Construct a new signal set service for the specified io_service. ]
- ]
-
-]
+[heading Remarks]
+
+Calls `SSL_CTX_load_verify_locations`.
-[heading Data Members]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.signal_set_service.id [*id]]]
- [The unique service identifier. ]
- ]
-]
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/signal_set_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
+[section:context ssl::context::context]
-[section:add signal_set_service::add]
+[indexterm2 context..ssl::context]
+Constructor.
-[indexterm2 add..signal_set_service]
-Add a signal to a signal\_set.
+ explicit ``[link boost_asio.reference.ssl__context.context.overload1 context]``(
+ method m);
+ `` [''''»''' [link boost_asio.reference.ssl__context.context.overload1 more...]]``
- boost::system::error_code add(
- implementation_type & impl,
- int signal_number,
- boost::system::error_code & ec);
+Deprecated constructor taking a reference to an [link boost_asio.reference.io_service `io_service`] object.
-[endsect]
+ ``[link boost_asio.reference.ssl__context.context.overload2 context]``(
+ boost::asio::io_service & ,
+ method m);
+ `` [''''»''' [link boost_asio.reference.ssl__context.context.overload2 more...]]``
+Move-construct a context from another.
-[section:async_wait signal_set_service::async_wait]
-[indexterm2 async_wait..signal_set_service]
+ ``[link boost_asio.reference.ssl__context.context.overload3 context]``(
+ context && other);
+ `` [''''»''' [link boost_asio.reference.ssl__context.context.overload3 more...]]``
- template<
- typename ``[link boost_asio.reference.SignalHandler SignalHandler]``>
- void async_wait(
- implementation_type & impl,
- SignalHandler handler);
+
+[section:overload1 ssl::context::context (1 of 3 overloads)]
+
+
+Constructor.
+
+
+ context(
+ method m);
@@ -78937,15 +82707,15 @@
-[section:cancel signal_set_service::cancel]
+[section:overload2 ssl::context::context (2 of 3 overloads)]
-[indexterm2 cancel..signal_set_service]
-Cancel all operations associated with the signal set.
+
+Deprecated constructor taking a reference to an [link boost_asio.reference.io_service `io_service`] object.
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+ context(
+ boost::asio::io_service & ,
+ method m);
@@ -78953,45 +82723,54 @@
-[section:clear signal_set_service::clear]
+[section:overload3 ssl::context::context (3 of 3 overloads)]
-[indexterm2 clear..signal_set_service]
-Remove all signals from a signal\_set.
+
+Move-construct a context from another.
- boost::system::error_code clear(
- implementation_type & impl,
- boost::system::error_code & ec);
+ context(
+ context && other);
+This constructor moves an SSL context from one object to another.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[other][The other context object from which the move will occur.]]
-[section:construct signal_set_service::construct]
+]
+
+
+[heading Remarks]
+
+Following the move, the following operations only are valid for the moved-from object:
+* Destruction.
+
+* As a target for move-assignment.
-[indexterm2 construct..signal_set_service]
-Construct a new signal set implementation.
- void construct(
- implementation_type & impl);
[endsect]
+[endsect]
-[section:destroy signal_set_service::destroy]
-[indexterm2 destroy..signal_set_service]
-Destroy a signal set implementation.
+[section:default_workarounds ssl::context::default_workarounds]
+[indexterm2 default_workarounds..ssl::context]
+Implement various bug workarounds.
- void destroy(
- implementation_type & impl);
+
+ static const int default_workarounds = implementation_defined;
@@ -78999,16 +82778,31 @@
-[section:get_io_service signal_set_service::get_io_service]
+[section:file_format ssl::context::file_format]
+[indexterm2 file_format..ssl::context]
+File format types.
-['Inherited from io_service.]
-[indexterm2 get_io_service..signal_set_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+ enum file_format
+
+[indexterm2 asn1..ssl::context]
+[indexterm2 pem..ssl::context]
+[heading Values]
+[variablelist
- boost::asio::io_service & get_io_service();
+ [
+ [asn1]
+ [ASN.1 file. ]
+ ]
+
+ [
+ [pem]
+ [PEM file. ]
+ ]
+
+]
@@ -79016,340 +82810,277 @@
-[section:id signal_set_service::id]
+[section:impl ssl::context::impl]
-[indexterm2 id..signal_set_service]
-The unique service identifier.
+[indexterm2 impl..ssl::context]
+(Deprecated: Use `native_handle()`.) Get the underlying implementation in the native type.
- static boost::asio::io_service::id id;
+ impl_type impl();
+
+This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
[endsect]
-[section:implementation_type signal_set_service::implementation_type]
+[section:impl_type ssl::context::impl_type]
-[indexterm2 implementation_type..signal_set_service]
-The type of a signal set implementation.
+[indexterm2 impl_type..ssl::context]
+(Deprecated: Use native\_handle\_type.) The native type of the SSL context.
- typedef implementation_defined implementation_type;
+ typedef SSL_CTX * impl_type;
[heading Requirements]
-[*Header: ][^boost/asio/signal_set_service.hpp]
+[*Header: ][^boost/asio/ssl/context.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
+[section:load_verify_file ssl::context::load_verify_file]
-[section:remove signal_set_service::remove]
+[indexterm2 load_verify_file..ssl::context]
+Load a certification authority file for performing verification.
-[indexterm2 remove..signal_set_service]
-Remove a signal to a signal\_set.
+ void ``[link boost_asio.reference.ssl__context.load_verify_file.overload1 load_verify_file]``(
+ const std::string & filename);
+ `` [''''»''' [link boost_asio.reference.ssl__context.load_verify_file.overload1 more...]]``
- boost::system::error_code remove(
- implementation_type & impl,
- int signal_number,
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.load_verify_file.overload2 load_verify_file]``(
+ const std::string & filename,
boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.load_verify_file.overload2 more...]]``
+[section:overload1 ssl::context::load_verify_file (1 of 2 overloads)]
-[endsect]
+Load a certification authority file for performing verification.
-[section:signal_set_service signal_set_service::signal_set_service]
+ void load_verify_file(
+ const std::string & filename);
-[indexterm2 signal_set_service..signal_set_service]
-Construct a new signal set service for the specified [link boost_asio.reference.io_service `io_service`].
+This function is used to load one or more trusted certification authorities from a file.
- signal_set_service(
- boost::asio::io_service & io_service);
+[heading Parameters]
+
+
+[variablelist
+
+[[filename][The name of a file containing certification authority certificates in PEM format.]]
+
+]
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[endsect]
-[section:socket_acceptor_service socket_acceptor_service]
+[heading Remarks]
+
+Calls `SSL_CTX_load_verify_locations`.
-Default service implementation for a socket acceptor.
- template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class socket_acceptor_service :
- public io_service::service
+[endsect]
-[heading Types]
-[table
- [[Name][Description]]
- [
+[section:overload2 ssl::context::load_verify_file (2 of 2 overloads)]
- [[link boost_asio.reference.socket_acceptor_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
-
- ]
- [
+Load a certification authority file for performing verification.
- [[link boost_asio.reference.socket_acceptor_service.implementation_type [*implementation_type]]]
- [The native type of the socket acceptor. ]
-
- ]
- [
+ boost::system::error_code load_verify_file(
+ const std::string & filename,
+ boost::system::error_code & ec);
- [[link boost_asio.reference.socket_acceptor_service.native_handle_type [*native_handle_type]]]
- [The native acceptor type. ]
-
- ]
- [
+This function is used to load the certificates for one or more trusted certification authorities from a file.
- [[link boost_asio.reference.socket_acceptor_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native acceptor type. ]
-
- ]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.socket_acceptor_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
+[variablelist
- ]
+[[filename][The name of a file containing certification authority certificates in PEM format.]]
+
+[[ec][Set to indicate what error occurred, if any.]]
]
-[heading Member Functions]
-[table
- [[Name][Description]]
+
+[heading Remarks]
+
+Calls `SSL_CTX_load_verify_locations`.
+
+
+
+
+[endsect]
+
+
+[endsect]
+
+
+[section:method ssl::context::method]
+
+[indexterm2 method..ssl::context]
+Different methods supported by a context.
+
+
+ enum method
+
+[indexterm2 sslv2..ssl::context]
+[indexterm2 sslv2_client..ssl::context]
+[indexterm2 sslv2_server..ssl::context]
+[indexterm2 sslv3..ssl::context]
+[indexterm2 sslv3_client..ssl::context]
+[indexterm2 sslv3_server..ssl::context]
+[indexterm2 tlsv1..ssl::context]
+[indexterm2 tlsv1_client..ssl::context]
+[indexterm2 tlsv1_server..ssl::context]
+[indexterm2 sslv23..ssl::context]
+[indexterm2 sslv23_client..ssl::context]
+[indexterm2 sslv23_server..ssl::context]
+
+[heading Values]
+[variablelist
[
- [[link boost_asio.reference.socket_acceptor_service.accept [*accept]]]
- [Accept a new connection. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.assign [*assign]]]
- [Assign an existing native acceptor to a socket acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.async_accept [*async_accept]]]
- [Start an asynchronous accept. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.bind [*bind]]]
- [Bind the socket acceptor to the specified local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the acceptor. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.close [*close]]]
- [Close a socket acceptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.construct [*construct]]]
- [Construct a new socket acceptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.destroy [*destroy]]]
- [Destroy a socket acceptor implementation. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.get_option [*get_option]]]
- [Get a socket option. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
- ]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.is_open [*is_open]]]
- [Determine whether the acceptor is open. ]
+ [sslv2]
+ [Generic SSL version 2. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.listen [*listen]]]
- [Place the socket acceptor into the state where it will listen for new connections. ]
+ [sslv2_client]
+ [SSL version 2 client. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.local_endpoint [*local_endpoint]]]
- [Get the local endpoint. ]
+ [sslv2_server]
+ [SSL version 2 server. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.move_assign [*move_assign]]]
- [Move-assign from another socket acceptor implementation. ]
+ [sslv3]
+ [Generic SSL version 3. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.move_construct [*move_construct]]]
- [Move-construct a new socket acceptor implementation. ]
+ [sslv3_client]
+ [SSL version 3 client. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native acceptor implementation. ]
+ [sslv3_server]
+ [SSL version 3 server. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.native_handle [*native_handle]]]
- [Get the native acceptor implementation. ]
+ [tlsv1]
+ [Generic TLS version 1. ]
]
-
- [
- [[link boost_asio.reference.socket_acceptor_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native acceptor implementation.
- Sets the non-blocking mode of the native acceptor implementation. ]
- ]
-
[
- [[link boost_asio.reference.socket_acceptor_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the acceptor.
-
- Sets the non-blocking mode of the acceptor. ]
+ [tlsv1_client]
+ [TLS version 1 client. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.open [*open]]]
- [Open a new socket acceptor implementation. ]
+ [tlsv1_server]
+ [TLS version 1 server. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.set_option [*set_option]]]
- [Set a socket option. ]
+ [sslv23]
+ [Generic SSL/TLS. ]
]
-
+
[
- [[link boost_asio.reference.socket_acceptor_service.socket_acceptor_service [*socket_acceptor_service]]]
- [Construct a new socket acceptor service for the specified io_service. ]
+ [sslv23_client]
+ [SSL/TLS client. ]
]
-
-]
-
-[heading Data Members]
-[table
- [[Name][Description]]
[
- [[link boost_asio.reference.socket_acceptor_service.id [*id]]]
- [The unique service identifier. ]
+ [sslv23_server]
+ [SSL/TLS server. ]
]
]
-[heading Requirements]
-
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-[section:accept socket_acceptor_service::accept]
-[indexterm2 accept..socket_acceptor_service]
-Accept a new connection.
+[endsect]
- template<
- typename ``[link boost_asio.reference.SocketService SocketService]``>
- boost::system::error_code accept(
- implementation_type & impl,
- basic_socket< protocol_type, SocketService > & peer,
- endpoint_type * peer_endpoint,
- boost::system::error_code & ec);
+[section:native_handle ssl::context::native_handle]
+[indexterm2 native_handle..ssl::context]
+Get the underlying implementation in the native type.
-[endsect]
+ native_handle_type native_handle();
-[section:assign socket_acceptor_service::assign]
+This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
-[indexterm2 assign..socket_acceptor_service]
-Assign an existing native acceptor to a socket acceptor.
+[endsect]
- boost::system::error_code assign(
- implementation_type & impl,
- const protocol_type & protocol,
- const native_handle_type & native_acceptor,
- boost::system::error_code & ec);
+[section:native_handle_type ssl::context::native_handle_type]
-[endsect]
+[indexterm2 native_handle_type..ssl::context]
+The native handle type of the SSL context.
+ typedef SSL_CTX * native_handle_type;
-[section:async_accept socket_acceptor_service::async_accept]
-[indexterm2 async_accept..socket_acceptor_service]
-Start an asynchronous accept.
+[heading Requirements]
- template<
- typename ``[link boost_asio.reference.SocketService SocketService]``,
- typename ``[link boost_asio.reference.AcceptHandler AcceptHandler]``>
- void async_accept(
- implementation_type & impl,
- basic_socket< protocol_type, SocketService > & peer,
- endpoint_type * peer_endpoint,
- AcceptHandler handler);
+[*Header: ][^boost/asio/ssl/context.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
-[section:bind socket_acceptor_service::bind]
+[section:no_sslv2 ssl::context::no_sslv2]
-[indexterm2 bind..socket_acceptor_service]
-Bind the socket acceptor to the specified local endpoint.
+[indexterm2 no_sslv2..ssl::context]
+Disable SSL v2.
- boost::system::error_code bind(
- implementation_type & impl,
- const endpoint_type & endpoint,
- boost::system::error_code & ec);
+ static const int no_sslv2 = implementation_defined;
@@ -79357,15 +83088,13 @@
-[section:cancel socket_acceptor_service::cancel]
+[section:no_sslv3 ssl::context::no_sslv3]
-[indexterm2 cancel..socket_acceptor_service]
-Cancel all asynchronous operations associated with the acceptor.
+[indexterm2 no_sslv3..ssl::context]
+Disable SSL v3.
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
+ static const int no_sslv3 = implementation_defined;
@@ -79373,15 +83102,13 @@
-[section:close socket_acceptor_service::close]
+[section:no_tlsv1 ssl::context::no_tlsv1]
-[indexterm2 close..socket_acceptor_service]
-Close a socket acceptor implementation.
+[indexterm2 no_tlsv1..ssl::context]
+Disable TLS v1.
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
+ static const int no_tlsv1 = implementation_defined;
@@ -79389,382 +83116,463 @@
-[section:construct socket_acceptor_service::construct]
-
-[indexterm2 construct..socket_acceptor_service]
-Construct a new socket acceptor implementation.
+[section:operator_eq_ ssl::context::operator=]
+[indexterm2 operator=..ssl::context]
+Move-assign a context from another.
- void construct(
- implementation_type & impl);
+ context & operator=(
+ context && other);
-[endsect]
+This assignment operator moves an SSL context from one object to another.
+[heading Parameters]
+
-[section:destroy socket_acceptor_service::destroy]
+[variablelist
+
+[[other][The other context object from which the move will occur.]]
-[indexterm2 destroy..socket_acceptor_service]
-Destroy a socket acceptor implementation.
+]
- void destroy(
- implementation_type & impl);
+[heading Remarks]
+
+Following the move, the following operations only are valid for the moved-from object:
+* Destruction.
+* As a target for move-assignment.
-[endsect]
-[section:endpoint_type socket_acceptor_service::endpoint_type]
-[indexterm2 endpoint_type..socket_acceptor_service]
-The endpoint type.
+[endsect]
- typedef protocol_type::endpoint endpoint_type;
+[section:options ssl::context::options]
+[indexterm2 options..ssl::context]
+Bitmask type for SSL options.
-[heading Requirements]
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
+ typedef int options;
-[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/context.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[section:get_io_service socket_acceptor_service::get_io_service]
+[endsect]
-['Inherited from io_service.]
-[indexterm2 get_io_service..socket_acceptor_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[section:password_purpose ssl::context::password_purpose]
- boost::asio::io_service & get_io_service();
+[indexterm2 password_purpose..ssl::context]
+Purpose of PEM password.
+ enum password_purpose
-[endsect]
+[indexterm2 for_reading..ssl::context]
+[indexterm2 for_writing..ssl::context]
+[heading Values]
+[variablelist
+ [
+ [for_reading]
+ [The password is needed for reading/decryption. ]
+ ]
-[section:get_option socket_acceptor_service::get_option]
+ [
+ [for_writing]
+ [The password is needed for writing/encryption. ]
+ ]
-[indexterm2 get_option..socket_acceptor_service]
-Get a socket option.
+]
- template<
- typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSocketOption & option,
- boost::system::error_code & ec) const;
+[endsect]
-[endsect]
+[section:set_default_verify_paths ssl::context::set_default_verify_paths]
+[indexterm2 set_default_verify_paths..ssl::context]
+Configures the context to use the default directories for finding certification authority certificates.
-[section:id socket_acceptor_service::id]
+ void ``[link boost_asio.reference.ssl__context.set_default_verify_paths.overload1 set_default_verify_paths]``();
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_default_verify_paths.overload1 more...]]``
-[indexterm2 id..socket_acceptor_service]
-The unique service identifier.
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.set_default_verify_paths.overload2 set_default_verify_paths]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_default_verify_paths.overload2 more...]]``
- static boost::asio::io_service::id id;
+[section:overload1 ssl::context::set_default_verify_paths (1 of 2 overloads)]
+Configures the context to use the default directories for finding certification authority certificates.
-[endsect]
+ void set_default_verify_paths();
-[section:implementation_type socket_acceptor_service::implementation_type]
+This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
-[indexterm2 implementation_type..socket_acceptor_service]
-The native type of the socket acceptor.
+[heading Exceptions]
+
- typedef implementation_defined implementation_type;
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_set_default_verify_paths`.
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:io_control socket_acceptor_service::io_control]
+[section:overload2 ssl::context::set_default_verify_paths (2 of 2 overloads)]
-[indexterm2 io_control..socket_acceptor_service]
-Perform an IO control command on the socket.
+Configures the context to use the default directories for finding certification authority certificates.
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- implementation_type & impl,
- IoControlCommand & command,
+
+ boost::system::error_code set_default_verify_paths(
boost::system::error_code & ec);
+This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any.]]
-[section:is_open socket_acceptor_service::is_open]
+]
-[indexterm2 is_open..socket_acceptor_service]
-Determine whether the acceptor is open.
+[heading Remarks]
+
+Calls `SSL_CTX_set_default_verify_paths`.
- bool is_open(
- const implementation_type & impl) const;
[endsect]
+[endsect]
-[section:listen socket_acceptor_service::listen]
+[section:set_options ssl::context::set_options]
-[indexterm2 listen..socket_acceptor_service]
-Place the socket acceptor into the state where it will listen for new connections.
+[indexterm2 set_options..ssl::context]
+Set options on the context.
- boost::system::error_code listen(
- implementation_type & impl,
- int backlog,
+ void ``[link boost_asio.reference.ssl__context.set_options.overload1 set_options]``(
+ options o);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_options.overload1 more...]]``
+
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.set_options.overload2 set_options]``(
+ options o,
boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_options.overload2 more...]]``
+[section:overload1 ssl::context::set_options (1 of 2 overloads)]
-[endsect]
+Set options on the context.
-[section:local_endpoint socket_acceptor_service::local_endpoint]
+ void set_options(
+ options o);
-[indexterm2 local_endpoint..socket_acceptor_service]
-Get the local endpoint.
+This function may be used to configure the SSL options used by the context.
- endpoint_type local_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+[heading Parameters]
+
+[variablelist
+
+[[o][A bitmask of options. The available option values are defined in the [link boost_asio.reference.ssl__context_base `ssl::context_base`] class. The options are bitwise-ored with any existing value for the options.]]
-[endsect]
+]
+[heading Exceptions]
+
-[section:move_assign socket_acceptor_service::move_assign]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[indexterm2 move_assign..socket_acceptor_service]
-Move-assign from another socket acceptor implementation.
+]
- void move_assign(
- implementation_type & impl,
- socket_acceptor_service & other_service,
- implementation_type & other_impl);
+[heading Remarks]
+
+Calls `SSL_CTX_set_options`.
-[endsect]
+[endsect]
-[section:move_construct socket_acceptor_service::move_construct]
-[indexterm2 move_construct..socket_acceptor_service]
-Move-construct a new socket acceptor implementation.
+[section:overload2 ssl::context::set_options (2 of 2 overloads)]
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+Set options on the context.
+ boost::system::error_code set_options(
+ options o,
+ boost::system::error_code & ec);
-[endsect]
+This function may be used to configure the SSL options used by the context.
-[section:native socket_acceptor_service::native]
+[heading Parameters]
+
-[indexterm2 native..socket_acceptor_service]
-(Deprecated: Use `native_handle()`.) Get the native acceptor implementation.
+[variablelist
+
+[[o][A bitmask of options. The available option values are defined in the [link boost_asio.reference.ssl__context_base `ssl::context_base`] class. The options are bitwise-ored with any existing value for the options.]]
+[[ec][Set to indicate what error occurred, if any.]]
- native_type native(
- implementation_type & impl);
+]
+[heading Remarks]
+
+Calls `SSL_CTX_set_options`.
-[endsect]
-[section:native_handle socket_acceptor_service::native_handle]
+[endsect]
-[indexterm2 native_handle..socket_acceptor_service]
-Get the native acceptor implementation.
+[endsect]
- native_handle_type native_handle(
- implementation_type & impl);
+[section:set_password_callback ssl::context::set_password_callback]
+[indexterm2 set_password_callback..ssl::context]
+Set the password callback.
-[endsect]
+ template<
+ typename PasswordCallback>
+ void ``[link boost_asio.reference.ssl__context.set_password_callback.overload1 set_password_callback]``(
+ PasswordCallback callback);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_password_callback.overload1 more...]]``
+ template<
+ typename PasswordCallback>
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.set_password_callback.overload2 set_password_callback]``(
+ PasswordCallback callback,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_password_callback.overload2 more...]]``
-[section:native_handle_type socket_acceptor_service::native_handle_type]
+[section:overload1 ssl::context::set_password_callback (1 of 2 overloads)]
-[indexterm2 native_handle_type..socket_acceptor_service]
-The native acceptor type.
+Set the password callback.
- typedef implementation_defined native_handle_type;
+ template<
+ typename PasswordCallback>
+ void set_password_callback(
+ PasswordCallback callback);
-[heading Requirements]
+This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Parameters]
+
+[variablelist
+
+[[callback][The function object to be used for obtaining the password. The function signature of the handler must be:
+``
+ std::string password_callback(
+ std::size_t max_length, // The maximum size for a password.
+ password_purpose purpose // Whether password is for reading or writing.
+ );
+``
+The return value of the callback is a string containing the password.]]
-[endsect]
+]
-[section:native_non_blocking socket_acceptor_service::native_non_blocking]
+[heading Exceptions]
+
-[indexterm2 native_non_blocking..socket_acceptor_service]
-Gets the non-blocking mode of the native acceptor implementation.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
- bool ``[link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload1 more...]]``
+[heading Remarks]
+
+Calls `SSL_CTX_set_default_passwd_cb`.
-Sets the non-blocking mode of the native acceptor implementation.
- boost::system::error_code ``[link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.socket_acceptor_service.native_non_blocking.overload2 more...]]``
+[endsect]
-[section:overload1 socket_acceptor_service::native_non_blocking (1 of 2 overloads)]
-Gets the non-blocking mode of the native acceptor implementation.
+[section:overload2 ssl::context::set_password_callback (2 of 2 overloads)]
- bool native_non_blocking(
- const implementation_type & impl) const;
+Set the password callback.
+ template<
+ typename PasswordCallback>
+ boost::system::error_code set_password_callback(
+ PasswordCallback callback,
+ boost::system::error_code & ec);
-[endsect]
+This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.
-[section:overload2 socket_acceptor_service::native_non_blocking (2 of 2 overloads)]
+[heading Parameters]
+
+[variablelist
+
+[[callback][The function object to be used for obtaining the password. The function signature of the handler must be:
+``
+ std::string password_callback(
+ std::size_t max_length, // The maximum size for a password.
+ password_purpose purpose // Whether password is for reading or writing.
+ );
+``
+The return value of the callback is a string containing the password.]]
-Sets the non-blocking mode of the native acceptor implementation.
+[[ec][Set to indicate what error occurred, if any.]]
+]
- boost::system::error_code native_non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+[heading Remarks]
+
+Calls `SSL_CTX_set_default_passwd_cb`.
-[endsect]
[endsect]
-[section:native_type socket_acceptor_service::native_type]
-
-[indexterm2 native_type..socket_acceptor_service]
-(Deprecated: Use native\_handle\_type.) The native acceptor type.
+[endsect]
+[section:set_verify_callback ssl::context::set_verify_callback]
- typedef implementation_defined native_type;
+[indexterm2 set_verify_callback..ssl::context]
+Set the callback used to verify peer certificates.
+ template<
+ typename VerifyCallback>
+ void ``[link boost_asio.reference.ssl__context.set_verify_callback.overload1 set_verify_callback]``(
+ VerifyCallback callback);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_callback.overload1 more...]]``
-[heading Requirements]
+ template<
+ typename VerifyCallback>
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.set_verify_callback.overload2 set_verify_callback]``(
+ VerifyCallback callback,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_callback.overload2 more...]]``
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload1 ssl::context::set_verify_callback (1 of 2 overloads)]
-[endsect]
+Set the callback used to verify peer certificates.
-[section:non_blocking socket_acceptor_service::non_blocking]
+ template<
+ typename VerifyCallback>
+ void set_verify_callback(
+ VerifyCallback callback);
-[indexterm2 non_blocking..socket_acceptor_service]
-Gets the non-blocking mode of the acceptor.
+This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
- bool ``[link boost_asio.reference.socket_acceptor_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.socket_acceptor_service.non_blocking.overload1 more...]]``
+[heading Parameters]
+
-Sets the non-blocking mode of the acceptor.
+[variablelist
+
+[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
+``
+ bool verify_callback(
+ bool preverified, // True if the certificate passed pre-verification.
+ verify_context& ctx // The peer certificate and other context.
+ );
+``
+The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+]
- boost::system::error_code ``[link boost_asio.reference.socket_acceptor_service.non_blocking.overload2 non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.socket_acceptor_service.non_blocking.overload2 more...]]``
+[heading Exceptions]
+
-[section:overload1 socket_acceptor_service::non_blocking (1 of 2 overloads)]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-Gets the non-blocking mode of the acceptor.
+[heading Remarks]
+
+Calls `SSL_CTX_set_verify`.
- bool non_blocking(
- const implementation_type & impl) const;
@@ -79772,90 +83580,106 @@
-[section:overload2 socket_acceptor_service::non_blocking (2 of 2 overloads)]
+[section:overload2 ssl::context::set_verify_callback (2 of 2 overloads)]
-Sets the non-blocking mode of the acceptor.
+Set the callback used to verify peer certificates.
- boost::system::error_code non_blocking(
- implementation_type & impl,
- bool mode,
+ template<
+ typename VerifyCallback>
+ boost::system::error_code set_verify_callback(
+ VerifyCallback callback,
boost::system::error_code & ec);
+This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
-[endsect]
+[heading Parameters]
+
-[endsect]
+[variablelist
+
+[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
+``
+ bool verify_callback(
+ bool preverified, // True if the certificate passed pre-verification.
+ verify_context& ctx // The peer certificate and other context.
+ );
+``
+The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+[[ec][Set to indicate what error occurred, if any.]]
-[section:open socket_acceptor_service::open]
+]
-[indexterm2 open..socket_acceptor_service]
-Open a new socket acceptor implementation.
+[heading Remarks]
+
+Calls `SSL_CTX_set_verify`.
- boost::system::error_code open(
- implementation_type & impl,
- const protocol_type & protocol,
- boost::system::error_code & ec);
[endsect]
+[endsect]
-[section:protocol_type socket_acceptor_service::protocol_type]
-
-[indexterm2 protocol_type..socket_acceptor_service]
-The protocol type.
-
+[section:set_verify_mode ssl::context::set_verify_mode]
- typedef Protocol protocol_type;
+[indexterm2 set_verify_mode..ssl::context]
+Set the peer verification mode.
+ void ``[link boost_asio.reference.ssl__context.set_verify_mode.overload1 set_verify_mode]``(
+ verify_mode v);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_mode.overload1 more...]]``
-[heading Requirements]
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.set_verify_mode.overload2 set_verify_mode]``(
+ verify_mode v,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_mode.overload2 more...]]``
-[*Header: ][^boost/asio/socket_acceptor_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[section:overload1 ssl::context::set_verify_mode (1 of 2 overloads)]
-[endsect]
+Set the peer verification mode.
+ void set_verify_mode(
+ verify_mode v);
-[section:set_option socket_acceptor_service::set_option]
-[indexterm2 set_option..socket_acceptor_service]
-Set a socket option.
+This function may be used to configure the peer verification mode used by the context.
- template<
- typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
- boost::system::error_code set_option(
- implementation_type & impl,
- const SettableSocketOption & option,
- boost::system::error_code & ec);
+[heading Parameters]
+
+[variablelist
+
+[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
+]
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[section:socket_acceptor_service socket_acceptor_service::socket_acceptor_service]
+]
-[indexterm2 socket_acceptor_service..socket_acceptor_service]
-Construct a new socket acceptor service for the specified [link boost_asio.reference.io_service `io_service`].
+[heading Remarks]
+
+Calls `SSL_CTX_set_verify`.
- socket_acceptor_service(
- boost::asio::io_service & io_service);
@@ -79863,594 +83687,580 @@
-[endsect]
-
-[section:socket_base socket_base]
-
+[section:overload2 ssl::context::set_verify_mode (2 of 2 overloads)]
-The [link boost_asio.reference.socket_base `socket_base`] class is used as a base for the [link boost_asio.reference.basic_stream_socket `basic_stream_socket`] and [link boost_asio.reference.basic_datagram_socket `basic_datagram_socket`] class templates so that we have a common place to define the shutdown\_type and enum.
+Set the peer verification mode.
- class socket_base
+ boost::system::error_code set_verify_mode(
+ verify_mode v,
+ boost::system::error_code & ec);
-[heading Types]
-[table
- [[Name][Description]]
- [
+This function may be used to configure the peer verification mode used by the context.
- [[link boost_asio.reference.socket_base.broadcast [*broadcast]]]
- [Socket option to permit sending of broadcast messages. ]
-
- ]
- [
+[heading Parameters]
+
- [[link boost_asio.reference.socket_base.bytes_readable [*bytes_readable]]]
- [IO control command to get the amount of data that can be read without blocking. ]
+[variablelist
- ]
+[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
- [
+[[ec][Set to indicate what error occurred, if any.]]
- [[link boost_asio.reference.socket_base.debug [*debug]]]
- [Socket option to enable socket-level debugging. ]
-
- ]
+]
- [
- [[link boost_asio.reference.socket_base.do_not_route [*do_not_route]]]
- [Socket option to prevent routing, use local interfaces only. ]
-
- ]
+[heading Remarks]
+
+Calls `SSL_CTX_set_verify`.
- [
- [[link boost_asio.reference.socket_base.enable_connection_aborted [*enable_connection_aborted]]]
- [Socket option to report aborted connections on accept. ]
-
- ]
- [
- [[link boost_asio.reference.socket_base.keep_alive [*keep_alive]]]
- [Socket option to send keep-alives. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.socket_base.linger [*linger]]]
- [Socket option to specify whether the socket lingers on close if unsent data is present. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.socket_base.message_flags [*message_flags]]]
- [Bitmask type for flags that can be passed to send and receive operations. ]
-
- ]
+[section:single_dh_use ssl::context::single_dh_use]
- [
+[indexterm2 single_dh_use..ssl::context]
+Always create a new key when using tmp\_dh parameters.
- [[link boost_asio.reference.socket_base.non_blocking_io [*non_blocking_io]]]
- [(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. ]
-
- ]
- [
+ static const int single_dh_use = implementation_defined;
- [[link boost_asio.reference.socket_base.receive_buffer_size [*receive_buffer_size]]]
- [Socket option for the receive buffer size of a socket. ]
-
- ]
- [
- [[link boost_asio.reference.socket_base.receive_low_watermark [*receive_low_watermark]]]
- [Socket option for the receive low watermark. ]
-
- ]
+[endsect]
- [
- [[link boost_asio.reference.socket_base.reuse_address [*reuse_address]]]
- [Socket option to allow the socket to be bound to an address that is already in use. ]
-
- ]
+[section:use_certificate_chain_file ssl::context::use_certificate_chain_file]
- [
+[indexterm2 use_certificate_chain_file..ssl::context]
+Use a certificate chain from a file.
- [[link boost_asio.reference.socket_base.send_buffer_size [*send_buffer_size]]]
- [Socket option for the send buffer size of a socket. ]
-
- ]
- [
+ void ``[link boost_asio.reference.ssl__context.use_certificate_chain_file.overload1 use_certificate_chain_file]``(
+ const std::string & filename);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_chain_file.overload1 more...]]``
- [[link boost_asio.reference.socket_base.send_low_watermark [*send_low_watermark]]]
- [Socket option for the send low watermark. ]
-
- ]
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.use_certificate_chain_file.overload2 use_certificate_chain_file]``(
+ const std::string & filename,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_chain_file.overload2 more...]]``
- [
- [[link boost_asio.reference.socket_base.shutdown_type [*shutdown_type]]]
- [Different ways a socket may be shutdown. ]
-
- ]
+[section:overload1 ssl::context::use_certificate_chain_file (1 of 2 overloads)]
-]
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
+Use a certificate chain from a file.
- [
- [[link boost_asio.reference.socket_base._socket_base [*~socket_base]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
-]
-[heading Data Members]
-[table
- [[Name][Description]]
+ void use_certificate_chain_file(
+ const std::string & filename);
- [
- [[link boost_asio.reference.socket_base.max_connections [*max_connections]]]
- [The maximum length of the queue of pending incoming connections. ]
- ]
- [
- [[link boost_asio.reference.socket_base.message_do_not_route [*message_do_not_route]]]
- [Specify that the data should not be subject to routing. ]
- ]
+This function is used to load a certificate chain into the context from a file.
- [
- [[link boost_asio.reference.socket_base.message_end_of_record [*message_end_of_record]]]
- [Specifies that the data marks the end of a record. ]
- ]
- [
- [[link boost_asio.reference.socket_base.message_out_of_band [*message_out_of_band]]]
- [Process out-of-band data. ]
- ]
+[heading Parameters]
+
- [
- [[link boost_asio.reference.socket_base.message_peek [*message_peek]]]
- [Peek at incoming data without removing it from the input queue. ]
- ]
+[variablelist
+
+[[filename][The name of the file containing the certificate. The file must use the PEM format.]]
]
-[heading Requirements]
-
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[section:broadcast socket_base::broadcast]
+]
-[indexterm2 broadcast..socket_base]
-Socket option to permit sending of broadcast messages.
+[heading Remarks]
+
+Calls `SSL_CTX_use_certificate_chain_file`.
- typedef implementation_defined broadcast;
-Implements the SOL\_SOCKET/SO\_BROADCAST socket option.
+[endsect]
-[heading Examples]
-
-Setting the option:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::socket_base::broadcast option(true);
- socket.set_option(option);
+[section:overload2 ssl::context::use_certificate_chain_file (2 of 2 overloads)]
+Use a certificate chain from a file.
+ boost::system::error_code use_certificate_chain_file(
+ const std::string & filename,
+ boost::system::error_code & ec);
-Getting the current option value:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::socket_base::broadcast option;
- socket.get_option(option);
- bool is_set = option.value();
+This function is used to load a certificate chain into the context from a file.
+[heading Parameters]
+
+[variablelist
+
+[[filename][The name of the file containing the certificate. The file must use the PEM format.]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_use_certificate_chain_file`.
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[endsect]
-[section:bytes_readable socket_base::bytes_readable]
-
-[indexterm2 bytes_readable..socket_base]
-IO control command to get the amount of data that can be read without blocking.
-
+[section:use_certificate_file ssl::context::use_certificate_file]
- typedef implementation_defined bytes_readable;
+[indexterm2 use_certificate_file..ssl::context]
+Use a certificate from a file.
+ void ``[link boost_asio.reference.ssl__context.use_certificate_file.overload1 use_certificate_file]``(
+ const std::string & filename,
+ file_format format);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_file.overload1 more...]]``
-Implements the FIONREAD IO control command.
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.use_certificate_file.overload2 use_certificate_file]``(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_file.overload2 more...]]``
-[heading Example]
-
+[section:overload1 ssl::context::use_certificate_file (1 of 2 overloads)]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::bytes_readable command(true);
- socket.io_control(command);
- std::size_t bytes_readable = command.get();
+Use a certificate from a file.
+ void use_certificate_file(
+ const std::string & filename,
+ file_format format);
+This function is used to load a certificate into the context from a file.
+[heading Parameters]
+
-[heading Requirements]
+[variablelist
+
+[[filename][The name of the file containing the certificate.]]
-[*Header: ][^boost/asio/socket_base.hpp]
+[[format][The file format (ASN.1 or PEM).]]
-[*Convenience header: ][^boost/asio.hpp]
+]
-[endsect]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[section:debug socket_base::debug]
-[indexterm2 debug..socket_base]
-Socket option to enable socket-level debugging.
+[heading Remarks]
+
+Calls `SSL_CTX_use_certificate_file`.
- typedef implementation_defined debug;
+[endsect]
-Implements the SOL\_SOCKET/SO\_DEBUG socket option.
-[heading Examples]
-
-Setting the option:
+[section:overload2 ssl::context::use_certificate_file (2 of 2 overloads)]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::debug option(true);
- socket.set_option(option);
+Use a certificate from a file.
+ boost::system::error_code use_certificate_file(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
-Getting the current option value:
+This function is used to load a certificate into the context from a file.
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::debug option;
- socket.get_option(option);
- bool is_set = option.value();
+[heading Parameters]
+
+[variablelist
+
+[[filename][The name of the file containing the certificate.]]
+[[format][The file format (ASN.1 or PEM).]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_use_certificate_file`.
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[endsect]
-[section:do_not_route socket_base::do_not_route]
-
-[indexterm2 do_not_route..socket_base]
-Socket option to prevent routing, use local interfaces only.
-
-
- typedef implementation_defined do_not_route;
-
-
+[section:use_private_key_file ssl::context::use_private_key_file]
-Implements the SOL\_SOCKET/SO\_DONTROUTE socket option.
+[indexterm2 use_private_key_file..ssl::context]
+Use a private key from a file.
-[heading Examples]
-
-Setting the option:
+ void ``[link boost_asio.reference.ssl__context.use_private_key_file.overload1 use_private_key_file]``(
+ const std::string & filename,
+ file_format format);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_private_key_file.overload1 more...]]``
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::socket_base::do_not_route option(true);
- socket.set_option(option);
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.use_private_key_file.overload2 use_private_key_file]``(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_private_key_file.overload2 more...]]``
+[section:overload1 ssl::context::use_private_key_file (1 of 2 overloads)]
+Use a private key from a file.
-Getting the current option value:
- boost::asio::ip::udp::socket socket(io_service);
- ...
- boost::asio::socket_base::do_not_route option;
- socket.get_option(option);
- bool is_set = option.value();
+ void use_private_key_file(
+ const std::string & filename,
+ file_format format);
+This function is used to load a private key into the context from a file.
+[heading Parameters]
+
+[variablelist
+
+[[filename][The name of the file containing the private key.]]
+[[format][The file format (ASN.1 or PEM).]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
-[endsect]
+]
+[heading Remarks]
+
+Calls `SSL_CTX_use_PrivateKey_file`.
-[section:enable_connection_aborted socket_base::enable_connection_aborted]
-[indexterm2 enable_connection_aborted..socket_base]
-Socket option to report aborted connections on accept.
- typedef implementation_defined enable_connection_aborted;
+[endsect]
-Implements a custom socket option that determines whether or not an accept operation is permitted to fail with `boost::asio::error::connection_aborted`. By default the option is false.
+[section:overload2 ssl::context::use_private_key_file (2 of 2 overloads)]
-[heading Examples]
-
-Setting the option:
+Use a private key from a file.
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- ...
- boost::asio::socket_base::enable_connection_aborted option(true);
- acceptor.set_option(option);
+ boost::system::error_code use_private_key_file(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
+This function is used to load a private key into the context from a file.
-Getting the current option value:
+[heading Parameters]
+
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- ...
- boost::asio::socket_base::enable_connection_aborted option;
- acceptor.get_option(option);
- bool is_set = option.value();
+[variablelist
+
+[[filename][The name of the file containing the private key.]]
+[[format][The file format (ASN.1 or PEM).]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
+[heading Remarks]
+
+Calls `SSL_CTX_use_PrivateKey_file`.
-[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[endsect]
[endsect]
+[section:use_rsa_private_key_file ssl::context::use_rsa_private_key_file]
+[indexterm2 use_rsa_private_key_file..ssl::context]
+Use an RSA private key from a file.
-[section:keep_alive socket_base::keep_alive]
-
-[indexterm2 keep_alive..socket_base]
-Socket option to send keep-alives.
+ void ``[link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload1 use_rsa_private_key_file]``(
+ const std::string & filename,
+ file_format format);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload1 more...]]``
- typedef implementation_defined keep_alive;
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2 use_rsa_private_key_file]``(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2 more...]]``
+[section:overload1 ssl::context::use_rsa_private_key_file (1 of 2 overloads)]
-Implements the SOL\_SOCKET/SO\_KEEPALIVE socket option.
+Use an RSA private key from a file.
-[heading Examples]
-
-Setting the option:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::keep_alive option(true);
- socket.set_option(option);
+ void use_rsa_private_key_file(
+ const std::string & filename,
+ file_format format);
+This function is used to load an RSA private key into the context from a file.
+[heading Parameters]
+
-Getting the current option value:
+[variablelist
+
+[[filename][The name of the file containing the RSA private key.]]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::keep_alive option;
- socket.get_option(option);
- bool is_set = option.value();
+[[format][The file format (ASN.1 or PEM).]]
+]
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_use_RSAPrivateKey_file`.
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:linger socket_base::linger]
+[section:overload2 ssl::context::use_rsa_private_key_file (2 of 2 overloads)]
-[indexterm2 linger..socket_base]
-Socket option to specify whether the socket lingers on close if unsent data is present.
+Use an RSA private key from a file.
- typedef implementation_defined linger;
+
+ boost::system::error_code use_rsa_private_key_file(
+ const std::string & filename,
+ file_format format,
+ boost::system::error_code & ec);
+This function is used to load an RSA private key into the context from a file.
-Implements the SOL\_SOCKET/SO\_LINGER socket option.
+[heading Parameters]
+
-[heading Examples]
+[variablelist
-Setting the option:
+[[filename][The name of the file containing the RSA private key.]]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::linger option(true, 30);
- socket.set_option(option);
+[[format][The file format (ASN.1 or PEM).]]
+[[ec][Set to indicate what error occurred, if any.]]
+]
+[heading Remarks]
+
+Calls `SSL_CTX_use_RSAPrivateKey_file`.
-Getting the current option value:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::linger option;
- socket.get_option(option);
- bool is_set = option.enabled();
- unsigned short timeout = option.timeout();
+[endsect]
+[endsect]
+[section:use_tmp_dh_file ssl::context::use_tmp_dh_file]
+[indexterm2 use_tmp_dh_file..ssl::context]
+Use the specified file to obtain the temporary Diffie-Hellman parameters.
-[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
+ void ``[link boost_asio.reference.ssl__context.use_tmp_dh_file.overload1 use_tmp_dh_file]``(
+ const std::string & filename);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_tmp_dh_file.overload1 more...]]``
-[*Convenience header: ][^boost/asio.hpp]
+ boost::system::error_code ``[link boost_asio.reference.ssl__context.use_tmp_dh_file.overload2 use_tmp_dh_file]``(
+ const std::string & filename,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__context.use_tmp_dh_file.overload2 more...]]``
-[endsect]
+[section:overload1 ssl::context::use_tmp_dh_file (1 of 2 overloads)]
+Use the specified file to obtain the temporary Diffie-Hellman parameters.
-[section:max_connections socket_base::max_connections]
-[indexterm2 max_connections..socket_base]
-The maximum length of the queue of pending incoming connections.
+ void use_tmp_dh_file(
+ const std::string & filename);
- static const int max_connections = implementation_defined;
+This function is used to load Diffie-Hellman parameters into the context from a file.
+[heading Parameters]
+
-[endsect]
+[variablelist
+
+[[filename][The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.]]
+]
-[section:message_do_not_route socket_base::message_do_not_route]
+[heading Exceptions]
+
-[indexterm2 message_do_not_route..socket_base]
-Specify that the data should not be subject to routing.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
- static const int message_do_not_route = implementation_defined;
+[heading Remarks]
+
+Calls `SSL_CTX_set_tmp_dh`.
-[endsect]
+[endsect]
-[section:message_end_of_record socket_base::message_end_of_record]
-[indexterm2 message_end_of_record..socket_base]
-Specifies that the data marks the end of a record.
+[section:overload2 ssl::context::use_tmp_dh_file (2 of 2 overloads)]
- static const int message_end_of_record = implementation_defined;
+Use the specified file to obtain the temporary Diffie-Hellman parameters.
-[endsect]
+ boost::system::error_code use_tmp_dh_file(
+ const std::string & filename,
+ boost::system::error_code & ec);
+This function is used to load Diffie-Hellman parameters into the context from a file.
-[section:message_flags socket_base::message_flags]
-[indexterm2 message_flags..socket_base]
-Bitmask type for flags that can be passed to send and receive operations.
+[heading Parameters]
+
+[variablelist
+
+[[filename][The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.]]
- typedef int message_flags;
+[[ec][Set to indicate what error occurred, if any.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Calls `SSL_CTX_set_tmp_dh`.
-[*Header: ][^boost/asio/socket_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[endsect]
+
-[section:message_out_of_band socket_base::message_out_of_band]
+[section:_context ssl::context::~context]
-[indexterm2 message_out_of_band..socket_base]
-Process out-of-band data.
+[indexterm2 ~context..ssl::context]
+Destructor.
- static const int message_out_of_band = implementation_defined;
+ ~context();
@@ -80458,359 +84268,486 @@
-[section:message_peek socket_base::message_peek]
+[endsect]
-[indexterm2 message_peek..socket_base]
-Peek at incoming data without removing it from the input queue.
+[section:ssl__context_base ssl::context_base]
- static const int message_peek = implementation_defined;
+The [link boost_asio.reference.ssl__context_base `ssl::context_base`] class is used as a base for the basic\_context class template so that we have a common place to define various enums.
+ class context_base
-[endsect]
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-[section:non_blocking_io socket_base::non_blocking_io]
+ [[link boost_asio.reference.ssl__context_base.file_format [*file_format]]]
+ [File format types. ]
+
+ ]
-[indexterm2 non_blocking_io..socket_base]
-(Deprecated: Use non\_blocking().) IO control command to set the blocking mode of the socket.
+ [
+ [[link boost_asio.reference.ssl__context_base.method [*method]]]
+ [Different methods supported by a context. ]
+
+ ]
- typedef implementation_defined non_blocking_io;
+ [
+ [[link boost_asio.reference.ssl__context_base.options [*options]]]
+ [Bitmask type for SSL options. ]
+
+ ]
+ [
-Implements the FIONBIO IO control command.
+ [[link boost_asio.reference.ssl__context_base.password_purpose [*password_purpose]]]
+ [Purpose of PEM password. ]
+
+ ]
+]
-[heading Example]
-
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ssl__context_base._context_base [*~context_base]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
+]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::non_blocking_io command(true);
- socket.io_control(command);
+[heading Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ssl__context_base.default_workarounds [*default_workarounds]]]
+ [Implement various bug workarounds. ]
+ ]
+ [
+ [[link boost_asio.reference.ssl__context_base.no_sslv2 [*no_sslv2]]]
+ [Disable SSL v2. ]
+ ]
+ [
+ [[link boost_asio.reference.ssl__context_base.no_sslv3 [*no_sslv3]]]
+ [Disable SSL v3. ]
+ ]
+ [
+ [[link boost_asio.reference.ssl__context_base.no_tlsv1 [*no_tlsv1]]]
+ [Disable TLS v1. ]
+ ]
+ [
+ [[link boost_asio.reference.ssl__context_base.single_dh_use [*single_dh_use]]]
+ [Always create a new key when using tmp_dh parameters. ]
+ ]
+]
[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
+[*Header: ][^boost/asio/ssl/context_base.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[endsect]
+[section:default_workarounds ssl::context_base::default_workarounds]
+[indexterm2 default_workarounds..ssl::context_base]
+Implement various bug workarounds.
-[section:receive_buffer_size socket_base::receive_buffer_size]
+ static const int default_workarounds = implementation_defined;
-[indexterm2 receive_buffer_size..socket_base]
-Socket option for the receive buffer size of a socket.
- typedef implementation_defined receive_buffer_size;
+[endsect]
-Implements the SOL\_SOCKET/SO\_RCVBUF socket option.
+[section:file_format ssl::context_base::file_format]
+
+[indexterm2 file_format..ssl::context_base]
+File format types.
-[heading Examples]
-
-Setting the option:
+ enum file_format
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::receive_buffer_size option(8192);
- socket.set_option(option);
+[indexterm2 asn1..ssl::context_base]
+[indexterm2 pem..ssl::context_base]
+[heading Values]
+[variablelist
+ [
+ [asn1]
+ [ASN.1 file. ]
+ ]
+ [
+ [pem]
+ [PEM file. ]
+ ]
+]
-Getting the current option value:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::receive_buffer_size option;
- socket.get_option(option);
- int size = option.value();
+[endsect]
+[section:method ssl::context_base::method]
+[indexterm2 method..ssl::context_base]
+Different methods supported by a context.
-[heading Requirements]
+ enum method
-[*Header: ][^boost/asio/socket_base.hpp]
+[indexterm2 sslv2..ssl::context_base]
+[indexterm2 sslv2_client..ssl::context_base]
+[indexterm2 sslv2_server..ssl::context_base]
+[indexterm2 sslv3..ssl::context_base]
+[indexterm2 sslv3_client..ssl::context_base]
+[indexterm2 sslv3_server..ssl::context_base]
+[indexterm2 tlsv1..ssl::context_base]
+[indexterm2 tlsv1_client..ssl::context_base]
+[indexterm2 tlsv1_server..ssl::context_base]
+[indexterm2 sslv23..ssl::context_base]
+[indexterm2 sslv23_client..ssl::context_base]
+[indexterm2 sslv23_server..ssl::context_base]
-[*Convenience header: ][^boost/asio.hpp]
+[heading Values]
+[variablelist
+ [
+ [sslv2]
+ [Generic SSL version 2. ]
+ ]
-[endsect]
+ [
+ [sslv2_client]
+ [SSL version 2 client. ]
+ ]
+ [
+ [sslv2_server]
+ [SSL version 2 server. ]
+ ]
+ [
+ [sslv3]
+ [Generic SSL version 3. ]
+ ]
-[section:receive_low_watermark socket_base::receive_low_watermark]
+ [
+ [sslv3_client]
+ [SSL version 3 client. ]
+ ]
-[indexterm2 receive_low_watermark..socket_base]
-Socket option for the receive low watermark.
+ [
+ [sslv3_server]
+ [SSL version 3 server. ]
+ ]
+ [
+ [tlsv1]
+ [Generic TLS version 1. ]
+ ]
- typedef implementation_defined receive_low_watermark;
+ [
+ [tlsv1_client]
+ [TLS version 1 client. ]
+ ]
+ [
+ [tlsv1_server]
+ [TLS version 1 server. ]
+ ]
+ [
+ [sslv23]
+ [Generic SSL/TLS. ]
+ ]
-Implements the SOL\_SOCKET/SO\_RCVLOWAT socket option.
+ [
+ [sslv23_client]
+ [SSL/TLS client. ]
+ ]
+ [
+ [sslv23_server]
+ [SSL/TLS server. ]
+ ]
-[heading Examples]
-
-Setting the option:
+]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::receive_low_watermark option(1024);
- socket.set_option(option);
+[endsect]
-Getting the current option value:
+[section:no_sslv2 ssl::context_base::no_sslv2]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::receive_low_watermark option;
- socket.get_option(option);
- int size = option.value();
+[indexterm2 no_sslv2..ssl::context_base]
+Disable SSL v2.
+ static const int no_sslv2 = implementation_defined;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
+[section:no_sslv3 ssl::context_base::no_sslv3]
+
+[indexterm2 no_sslv3..ssl::context_base]
+Disable SSL v3.
+
+
+ static const int no_sslv3 = implementation_defined;
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:reuse_address socket_base::reuse_address]
+[section:no_tlsv1 ssl::context_base::no_tlsv1]
-[indexterm2 reuse_address..socket_base]
-Socket option to allow the socket to be bound to an address that is already in use.
+[indexterm2 no_tlsv1..ssl::context_base]
+Disable TLS v1.
- typedef implementation_defined reuse_address;
+ static const int no_tlsv1 = implementation_defined;
-Implements the SOL\_SOCKET/SO\_REUSEADDR socket option.
+[endsect]
-[heading Examples]
-
-Setting the option:
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- ...
- boost::asio::socket_base::reuse_address option(true);
- acceptor.set_option(option);
+[section:options ssl::context_base::options]
+[indexterm2 options..ssl::context_base]
+Bitmask type for SSL options.
+ typedef int options;
-Getting the current option value:
- boost::asio::ip::tcp::acceptor acceptor(io_service);
- ...
- boost::asio::socket_base::reuse_address option;
- acceptor.get_option(option);
- bool is_set = option.value();
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/context_base.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
+[endsect]
-[heading Requirements]
+[section:password_purpose ssl::context_base::password_purpose]
-[*Header: ][^boost/asio/socket_base.hpp]
+[indexterm2 password_purpose..ssl::context_base]
+Purpose of PEM password.
-[*Convenience header: ][^boost/asio.hpp]
+ enum password_purpose
+
+[indexterm2 for_reading..ssl::context_base]
+[indexterm2 for_writing..ssl::context_base]
+
+[heading Values]
+[variablelist
-[endsect]
+ [
+ [for_reading]
+ [The password is needed for reading/decryption. ]
+ ]
+ [
+ [for_writing]
+ [The password is needed for writing/encryption. ]
+ ]
+]
-[section:send_buffer_size socket_base::send_buffer_size]
-[indexterm2 send_buffer_size..socket_base]
-Socket option for the send buffer size of a socket.
+[endsect]
- typedef implementation_defined send_buffer_size;
+[section:single_dh_use ssl::context_base::single_dh_use]
-Implements the SOL\_SOCKET/SO\_SNDBUF socket option.
+[indexterm2 single_dh_use..ssl::context_base]
+Always create a new key when using tmp\_dh parameters.
-[heading Examples]
-
-Setting the option:
+ static const int single_dh_use = implementation_defined;
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::send_buffer_size option(8192);
- socket.set_option(option);
+[endsect]
-Getting the current option value:
+[section:_context_base ssl::context_base::~context_base]
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::send_buffer_size option;
- socket.get_option(option);
- int size = option.value();
+[indexterm2 ~context_base..ssl::context_base]
+Protected destructor to prevent deletion through this type.
+ ~context_base();
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
+[section:ssl__rfc2818_verification ssl::rfc2818_verification]
-[endsect]
+Verifies a certificate against a hostname according to the rules described in RFC 2818.
+ class rfc2818_verification
-[section:send_low_watermark socket_base::send_low_watermark]
-[indexterm2 send_low_watermark..socket_base]
-Socket option for the send low watermark.
+[heading Types]
+[table
+ [[Name][Description]]
+ [
- typedef implementation_defined send_low_watermark;
+ [[link boost_asio.reference.ssl__rfc2818_verification.result_type [*result_type]]]
+ [The type of the function object's result. ]
+
+ ]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-Implements the SOL\_SOCKET/SO\_SNDLOWAT socket option.
+ [
+ [[link boost_asio.reference.ssl__rfc2818_verification.operator_lp__rp_ [*operator()]]]
+ [Perform certificate verification. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__rfc2818_verification.rfc2818_verification [*rfc2818_verification]]]
+ [Constructor. ]
+ ]
+
+]
-[heading Examples]
+[heading Example]
-Setting the option:
+The following example shows how to synchronously open a secure connection to a given host name:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::send_low_watermark option(1024);
- socket.set_option(option);
+ using boost::asio::ip::tcp;
+ namespace ssl = boost::asio::ssl;
+ typedef ssl::stream<tcp::socket> ssl_socket;
+ // Create a context that uses the default paths for finding CA certificates.
+ ssl::context ctx(ssl::context::sslv23);
+ ctx.set_default_verify_paths();
+ // Open a socket and connect it to the remote host.
+ boost::asio::io_service io_service;
+ ssl_socket sock(io_service, ctx);
+ tcp::resolver resolver(io_service);
+ tcp::resolver::query query("host.name", "https");
+ boost::asio::connect(sock.lowest_layer(), resolver.resolve(query));
+ sock.lowest_layer().set_option(tcp::no_delay(true));
+ // Perform SSL handshake and verify the remote host's certificate.
+ sock.set_verify_mode(ssl::verify_peer);
+ sock.set_verify_callback(ssl::rfc2818_verification("host.name"));
+ sock.handshake(ssl_socket::client);
+ // ... read and write as normal ...
-Getting the current option value:
- boost::asio::ip::tcp::socket socket(io_service);
- ...
- boost::asio::socket_base::send_low_watermark option;
- socket.get_option(option);
- int size = option.value();
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/rfc2818_verification.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[heading Requirements]
-[*Header: ][^boost/asio/socket_base.hpp]
+[section:operator_lp__rp_ ssl::rfc2818_verification::operator()]
-[*Convenience header: ][^boost/asio.hpp]
+[indexterm2 operator()..ssl::rfc2818_verification]
+Perform certificate verification.
-[endsect]
+ bool operator()(
+ bool preverified,
+ verify_context & ctx) const;
-[section:shutdown_type socket_base::shutdown_type]
+[endsect]
-[indexterm2 shutdown_type..socket_base]
-Different ways a socket may be shutdown.
- enum shutdown_type
+[section:result_type ssl::rfc2818_verification::result_type]
-[indexterm2 shutdown_receive..socket_base]
-[indexterm2 shutdown_send..socket_base]
-[indexterm2 shutdown_both..socket_base]
+[indexterm2 result_type..ssl::rfc2818_verification]
+The type of the function object's result.
-[heading Values]
-[variablelist
- [
- [shutdown_receive]
- [Shutdown the receive side of the socket. ]
- ]
+ typedef bool result_type;
- [
- [shutdown_send]
- [Shutdown the send side of the socket. ]
- ]
- [
- [shutdown_both]
- [Shutdown both send and receive on the socket. ]
- ]
-]
+[heading Requirements]
+
+[*Header: ][^boost/asio/ssl/rfc2818_verification.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
-[section:_socket_base socket_base::~socket_base]
+[section:rfc2818_verification ssl::rfc2818_verification::rfc2818_verification]
-[indexterm2 ~socket_base..socket_base]
-Protected destructor to prevent deletion through this type.
+[indexterm2 rfc2818_verification..ssl::rfc2818_verification]
+Constructor.
- ~socket_base();
+ rfc2818_verification(
+ const std::string & host);
@@ -80820,12 +84757,16 @@
[endsect]
-[section:ssl__context ssl::context]
+[section:ssl__stream ssl::stream]
+Provides stream-oriented functionality using SSL.
- class context :
- public ssl::context_base,
+
+ template<
+ typename Stream>
+ class stream :
+ public ssl::stream_base,
noncopyable
@@ -80835,43 +84776,43 @@
[
- [[link boost_asio.reference.ssl__context.file_format [*file_format]]]
- [File format types. ]
+ [[link boost_asio.reference.ssl__stream__impl_struct [*impl_struct]]]
+ [Structure for use with deprecated impl_type. ]
]
[
- [[link boost_asio.reference.ssl__context.impl_type [*impl_type]]]
- [(Deprecated: Use native_handle_type.) The native type of the SSL context. ]
+ [[link boost_asio.reference.ssl__stream.handshake_type [*handshake_type]]]
+ [Different handshake types. ]
]
[
- [[link boost_asio.reference.ssl__context.method [*method]]]
- [Different methods supported by a context. ]
+ [[link boost_asio.reference.ssl__stream.impl_type [*impl_type]]]
+ [(Deprecated: Use native_handle_type.) The underlying implementation type. ]
]
[
- [[link boost_asio.reference.ssl__context.native_handle_type [*native_handle_type]]]
- [The native handle type of the SSL context. ]
+ [[link boost_asio.reference.ssl__stream.lowest_layer_type [*lowest_layer_type]]]
+ [The type of the lowest layer. ]
]
[
- [[link boost_asio.reference.ssl__context.options [*options]]]
- [Bitmask type for SSL options. ]
+ [[link boost_asio.reference.ssl__stream.native_handle_type [*native_handle_type]]]
+ [The native handle type of the SSL stream. ]
]
[
- [[link boost_asio.reference.ssl__context.password_purpose [*password_purpose]]]
- [Purpose of PEM password. ]
+ [[link boost_asio.reference.ssl__stream.next_layer_type [*next_layer_type]]]
+ [The type of the next layer. ]
]
@@ -80882,160 +84823,137 @@
[[Name][Description]]
[
- [[link boost_asio.reference.ssl__context.add_verify_path [*add_verify_path]]]
- [Add a directory containing certificate authority files to be used for performing verification. ]
+ [[link boost_asio.reference.ssl__stream.async_handshake [*async_handshake]]]
+ [Start an asynchronous SSL handshake. ]
]
[
- [[link boost_asio.reference.ssl__context.context [*context]]]
- [Constructor.
-
- Deprecated constructor taking a reference to an io_service object.
-
- Move-construct a context from another. ]
+ [[link boost_asio.reference.ssl__stream.async_read_some [*async_read_some]]]
+ [Start an asynchronous read. ]
]
[
- [[link boost_asio.reference.ssl__context.impl [*impl]]]
- [(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
+ [[link boost_asio.reference.ssl__stream.async_shutdown [*async_shutdown]]]
+ [Asynchronously shut down SSL on the stream. ]
]
[
- [[link boost_asio.reference.ssl__context.load_verify_file [*load_verify_file]]]
- [Load a certification authority file for performing verification. ]
+ [[link boost_asio.reference.ssl__stream.async_write_some [*async_write_some]]]
+ [Start an asynchronous write. ]
]
[
- [[link boost_asio.reference.ssl__context.native_handle [*native_handle]]]
- [Get the underlying implementation in the native type. ]
+ [[link boost_asio.reference.ssl__stream.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.ssl__context.operator_eq_ [*operator=]]]
- [Move-assign a context from another. ]
+ [[link boost_asio.reference.ssl__stream.handshake [*handshake]]]
+ [Perform SSL handshaking. ]
]
[
- [[link boost_asio.reference.ssl__context.set_default_verify_paths [*set_default_verify_paths]]]
- [Configures the context to use the default directories for finding certification authority certificates. ]
+ [[link boost_asio.reference.ssl__stream.impl [*impl]]]
+ [(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
]
[
- [[link boost_asio.reference.ssl__context.set_options [*set_options]]]
- [Set options on the context. ]
+ [[link boost_asio.reference.ssl__stream.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.ssl__context.set_password_callback [*set_password_callback]]]
- [Set the password callback. ]
+ [[link boost_asio.reference.ssl__stream.native_handle [*native_handle]]]
+ [Get the underlying implementation in the native type. ]
]
[
- [[link boost_asio.reference.ssl__context.set_verify_callback [*set_verify_callback]]]
- [Set the callback used to verify peer certificates. ]
+ [[link boost_asio.reference.ssl__stream.next_layer [*next_layer]]]
+ [Get a reference to the next layer. ]
]
[
- [[link boost_asio.reference.ssl__context.set_verify_mode [*set_verify_mode]]]
- [Set the peer verification mode. ]
+ [[link boost_asio.reference.ssl__stream.read_some [*read_some]]]
+ [Read some data from the stream. ]
]
[
- [[link boost_asio.reference.ssl__context.use_certificate_chain_file [*use_certificate_chain_file]]]
- [Use a certificate chain from a file. ]
+ [[link boost_asio.reference.ssl__stream.set_verify_callback [*set_verify_callback]]]
+ [Set the callback used to verify peer certificates. ]
]
[
- [[link boost_asio.reference.ssl__context.use_certificate_file [*use_certificate_file]]]
- [Use a certificate from a file. ]
+ [[link boost_asio.reference.ssl__stream.set_verify_mode [*set_verify_mode]]]
+ [Set the peer verification mode. ]
]
[
- [[link boost_asio.reference.ssl__context.use_private_key_file [*use_private_key_file]]]
- [Use a private key from a file. ]
+ [[link boost_asio.reference.ssl__stream.shutdown [*shutdown]]]
+ [Shut down SSL on the stream. ]
]
[
- [[link boost_asio.reference.ssl__context.use_rsa_private_key_file [*use_rsa_private_key_file]]]
- [Use an RSA private key from a file. ]
+ [[link boost_asio.reference.ssl__stream.stream [*stream]]]
+ [Construct a stream. ]
]
[
- [[link boost_asio.reference.ssl__context.use_tmp_dh_file [*use_tmp_dh_file]]]
- [Use the specified file to obtain the temporary Diffie-Hellman parameters. ]
+ [[link boost_asio.reference.ssl__stream.write_some [*write_some]]]
+ [Write some data to the stream. ]
]
[
- [[link boost_asio.reference.ssl__context._context [*~context]]]
+ [[link boost_asio.reference.ssl__stream._stream [*~stream]]]
[Destructor. ]
]
]
-[heading Data Members]
-[table
- [[Name][Description]]
+The stream class template provides asynchronous and blocking stream-oriented functionality using SSL.
- [
- [[link boost_asio.reference.ssl__context.default_workarounds [*default_workarounds]]]
- [Implement various bug workarounds. ]
- ]
- [
- [[link boost_asio.reference.ssl__context.no_sslv2 [*no_sslv2]]]
- [Disable SSL v2. ]
- ]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
- [
- [[link boost_asio.reference.ssl__context.no_sslv3 [*no_sslv3]]]
- [Disable SSL v3. ]
- ]
+[*Shared] [*objects:] Unsafe. The application must also ensure that all asynchronous operations are performed within the same implicit or explicit strand.
- [
- [[link boost_asio.reference.ssl__context.no_tlsv1 [*no_tlsv1]]]
- [Disable TLS v1. ]
- ]
- [
- [[link boost_asio.reference.ssl__context.single_dh_use [*single_dh_use]]]
- [Always create a new key when using tmp_dh parameters. ]
- ]
+[heading Example]
+
+To use the SSL stream template with an `ip::tcp::socket`, you would write:
-]
+ boost::asio::io_service io_service;
+ boost::asio::ssl::context ctx(boost::asio::ssl::context::sslv23);
+ boost::asio::ssl::stream<asio:ip::tcp::socket> sock(io_service, ctx);
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/context.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
-[section:add_verify_path ssl::context::add_verify_path]
-[indexterm2 add_verify_path..ssl::context]
-Add a directory containing certificate authority files to be used for performing verification.
- void ``[link boost_asio.reference.ssl__context.add_verify_path.overload1 add_verify_path]``(
- const std::string & path);
- `` [''''»''' [link boost_asio.reference.ssl__context.add_verify_path.overload1 more...]]``
+[heading Requirements]
- boost::system::error_code ``[link boost_asio.reference.ssl__context.add_verify_path.overload2 add_verify_path]``(
- const std::string & path,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.add_verify_path.overload2 more...]]``
+[*Header: ][^boost/asio/ssl/stream.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[section:overload1 ssl::context::add_verify_path (1 of 2 overloads)]
+[section:async_handshake ssl::stream::async_handshake]
-Add a directory containing certificate authority files to be used for performing verification.
+[indexterm2 async_handshake..ssl::stream]
+Start an asynchronous SSL handshake.
- void add_verify_path(
- const std::string & path);
+ template<
+ typename ``[link boost_asio.reference.HandshakeHandler HandshakeHandler]``>
+ void async_handshake(
+ handshake_type type,
+ HandshakeHandler handler);
-This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".
+This function is used to asynchronously perform an SSL handshake on the stream. This function call always returns immediately.
[heading Parameters]
@@ -81043,24 +84961,64 @@
[variablelist
-[[path][The name of a directory containing the certificates.]]
+[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
+
+[[handler][The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error // Result of operation.
+ );
+``
+]]
]
-[heading Exceptions]
+
+
+[endsect]
+
+
+
+[section:async_read_some ssl::stream::async_read_some]
+
+[indexterm2 async_read_some..ssl::stream]
+Start an asynchronous read.
+
+
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_read_some(
+ const MutableBufferSequence & buffers,
+ ReadHandler handler);
+
+
+This function is used to asynchronously read one or more bytes of data from the stream. The function call always returns immediately.
+
+
+[heading Parameters]
[variablelist
-[[boost::system::system_error][Thrown on failure.]]
+[[buffers][The buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
+
+[[handler][The handler to be called when the read operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ std::size_t bytes_transferred // Number of bytes read.
+ );
+``
+]]
]
[heading Remarks]
-Calls `SSL_CTX_load_verify_locations`.
+The async\_read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.async_read `async_read`] function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.
@@ -81069,18 +85027,19 @@
-[section:overload2 ssl::context::add_verify_path (2 of 2 overloads)]
-
+[section:async_shutdown ssl::stream::async_shutdown]
-Add a directory containing certificate authority files to be used for performing verification.
+[indexterm2 async_shutdown..ssl::stream]
+Asynchronously shut down SSL on the stream.
- boost::system::error_code add_verify_path(
- const std::string & path,
- boost::system::error_code & ec);
+ template<
+ typename ``[link boost_asio.reference.ShutdownHandler ShutdownHandler]``>
+ void async_shutdown(
+ ShutdownHandler handler);
-This function is used to specify the name of a directory containing certification authority certificates. Each file in the directory must contain a single certificate. The files must be named using the subject name's hash and an extension of ".0".
+This function is used to asynchronously shut down SSL on the stream. This function call always returns immediately.
[heading Parameters]
@@ -81088,95 +85047,119 @@
[variablelist
-[[path][The name of a directory containing the certificates.]]
-
-[[ec][Set to indicate what error occurred, if any.]]
+[[handler][The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error // Result of operation.
+ );
+``
+]]
]
-[heading Remarks]
-
-Calls `SSL_CTX_load_verify_locations`.
-
-
[endsect]
-[endsect]
-[section:context ssl::context::context]
+[section:async_write_some ssl::stream::async_write_some]
-[indexterm2 context..ssl::context]
-Constructor.
+[indexterm2 async_write_some..ssl::stream]
+Start an asynchronous write.
- explicit ``[link boost_asio.reference.ssl__context.context.overload1 context]``(
- method m);
- `` [''''»''' [link boost_asio.reference.ssl__context.context.overload1 more...]]``
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_write_some(
+ const ConstBufferSequence & buffers,
+ WriteHandler handler);
-Deprecated constructor taking a reference to an [link boost_asio.reference.io_service `io_service`] object.
+This function is used to asynchronously write one or more bytes of data to the stream. The function call always returns immediately.
- ``[link boost_asio.reference.ssl__context.context.overload2 context]``(
- boost::asio::io_service & ,
- method m);
- `` [''''»''' [link boost_asio.reference.ssl__context.context.overload2 more...]]``
+[heading Parameters]
+
+[variablelist
+
+[[buffers][The data to be written to the stream. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
-Move-construct a context from another.
+[[handler][The handler to be called when the write operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error, // Result of operation.
+ std::size_t bytes_transferred // Number of bytes written.
+ );
+``
+]]
+]
- ``[link boost_asio.reference.ssl__context.context.overload3 context]``(
- context && other);
- `` [''''»''' [link boost_asio.reference.ssl__context.context.overload3 more...]]``
+[heading Remarks]
+
+The async\_write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.async_write `async_write`] function if you need to ensure that all data is written before the blocking operation completes.
-[section:overload1 ssl::context::context (1 of 3 overloads)]
-Constructor.
+[endsect]
- context(
- method m);
+[section:get_io_service ssl::stream::get_io_service]
-[endsect]
+[indexterm2 get_io_service..ssl::stream]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+ boost::asio::io_service & get_io_service();
-[section:overload2 ssl::context::context (2 of 3 overloads)]
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the stream uses to dispatch handlers for asynchronous operations.
-Deprecated constructor taking a reference to an [link boost_asio.reference.io_service `io_service`] object.
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that stream will use to dispatch handlers. Ownership is not transferred to the caller.
- context(
- boost::asio::io_service & ,
- method m);
[endsect]
+[section:handshake ssl::stream::handshake]
+
+[indexterm2 handshake..ssl::stream]
+Perform SSL handshaking.
-[section:overload3 ssl::context::context (3 of 3 overloads)]
+ void ``[link boost_asio.reference.ssl__stream.handshake.overload1 handshake]``(
+ handshake_type type);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.handshake.overload1 more...]]``
-Move-construct a context from another.
+ boost::system::error_code ``[link boost_asio.reference.ssl__stream.handshake.overload2 handshake]``(
+ handshake_type type,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.handshake.overload2 more...]]``
- context(
- context && other);
+[section:overload1 ssl::stream::handshake (1 of 2 overloads)]
-This constructor moves an SSL context from one object to another.
+Perform SSL handshaking.
+
+
+ void handshake(
+ handshake_type type);
+
+
+This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.
[heading Parameters]
@@ -81184,65 +85167,83 @@
[variablelist
-[[other][The other context object from which the move will occur.]]
+[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
+
+]
+
+
+[heading Exceptions]
+
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
]
-[heading Remarks]
-
-Following the move, the following operations only are valid for the moved-from object:
-* Destruction.
-* As a target for move-assignment.
+[endsect]
+
+
+
+[section:overload2 ssl::stream::handshake (2 of 2 overloads)]
+Perform SSL handshaking.
+ boost::system::error_code handshake(
+ handshake_type type,
+ boost::system::error_code & ec);
-[endsect]
+This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.
-[endsect]
+[heading Parameters]
+
-[section:default_workarounds ssl::context::default_workarounds]
+[variablelist
+
+[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
-[indexterm2 default_workarounds..ssl::context]
-Implement various bug workarounds.
+[[ec][Set to indicate what error occurred, if any. ]]
+]
- static const int default_workarounds = implementation_defined;
[endsect]
+[endsect]
-[section:file_format ssl::context::file_format]
-[indexterm2 file_format..ssl::context]
-File format types.
+[section:handshake_type ssl::stream::handshake_type]
+[indexterm2 handshake_type..ssl::stream]
+Different handshake types.
- enum file_format
-[indexterm2 asn1..ssl::context]
-[indexterm2 pem..ssl::context]
+ enum handshake_type
+
+[indexterm2 client..ssl::stream]
+[indexterm2 server..ssl::stream]
[heading Values]
[variablelist
[
- [asn1]
- [ASN.1 file. ]
+ [client]
+ [Perform handshaking as a client. ]
]
[
- [pem]
- [PEM file. ]
+ [server]
+ [Perform handshaking as a server. ]
]
]
@@ -81253,35 +85254,35 @@
-[section:impl ssl::context::impl]
+[section:impl ssl::stream::impl]
-[indexterm2 impl..ssl::context]
+[indexterm2 impl..ssl::stream]
(Deprecated: Use `native_handle()`.) Get the underlying implementation in the native type.
impl_type impl();
-This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
+This function may be used to obtain the underlying implementation of the context. This is intended to allow access to stream functionality that is not otherwise provided.
[endsect]
-[section:impl_type ssl::context::impl_type]
+[section:impl_type ssl::stream::impl_type]
-[indexterm2 impl_type..ssl::context]
-(Deprecated: Use native\_handle\_type.) The native type of the SSL context.
+[indexterm2 impl_type..ssl::stream]
+(Deprecated: Use native\_handle\_type.) The underlying implementation type.
- typedef SSL_CTX * impl_type;
+ typedef impl_struct * impl_type;
[heading Requirements]
-[*Header: ][^boost/asio/ssl/context.hpp]
+[*Header: ][^boost/asio/ssl/stream.hpp]
[*Convenience header: ][^boost/asio/ssl.hpp]
@@ -81289,58 +85290,57 @@
[endsect]
-[section:load_verify_file ssl::context::load_verify_file]
+[section:lowest_layer ssl::stream::lowest_layer]
-[indexterm2 load_verify_file..ssl::context]
-Load a certification authority file for performing verification.
+[indexterm2 lowest_layer..ssl::stream]
+Get a reference to the lowest layer.
- void ``[link boost_asio.reference.ssl__context.load_verify_file.overload1 load_verify_file]``(
- const std::string & filename);
- `` [''''»''' [link boost_asio.reference.ssl__context.load_verify_file.overload1 more...]]``
+ lowest_layer_type & ``[link boost_asio.reference.ssl__stream.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.ssl__stream.lowest_layer.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__context.load_verify_file.overload2 load_verify_file]``(
- const std::string & filename,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.load_verify_file.overload2 more...]]``
+ const lowest_layer_type & ``[link boost_asio.reference.ssl__stream.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.ssl__stream.lowest_layer.overload2 more...]]``
-[section:overload1 ssl::context::load_verify_file (1 of 2 overloads)]
+[section:overload1 ssl::stream::lowest_layer (1 of 2 overloads)]
-Load a certification authority file for performing verification.
+Get a reference to the lowest layer.
- void load_verify_file(
- const std::string & filename);
+ lowest_layer_type & lowest_layer();
-This function is used to load one or more trusted certification authorities from a file.
+This function returns a reference to the lowest layer in a stack of stream layers.
-[heading Parameters]
-
+[heading Return Value]
+
+A reference to the lowest layer in the stack of stream layers. Ownership is not transferred to the caller.
-[variablelist
-
-[[filename][The name of a file containing certification authority certificates in PEM format.]]
-]
-[heading Exceptions]
-
+[endsect]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[section:overload2 ssl::stream::lowest_layer (2 of 2 overloads)]
-[heading Remarks]
+
+Get a reference to the lowest layer.
+
+
+ const lowest_layer_type & lowest_layer() const;
+
+
+This function returns a reference to the lowest layer in a stack of stream layers.
+
+
+[heading Return Value]
-Calls `SSL_CTX_load_verify_locations`.
+A reference to the lowest layer in the stack of stream layers. Ownership is not transferred to the caller.
@@ -81348,228 +85348,202 @@
[endsect]
+[endsect]
-[section:overload2 ssl::context::load_verify_file (2 of 2 overloads)]
+[section:lowest_layer_type ssl::stream::lowest_layer_type]
-Load a certification authority file for performing verification.
+[indexterm2 lowest_layer_type..ssl::stream]
+The type of the lowest layer.
- boost::system::error_code load_verify_file(
- const std::string & filename,
- boost::system::error_code & ec);
+ typedef next_layer_type::lowest_layer_type lowest_layer_type;
-This function is used to load the certificates for one or more trusted certification authorities from a file.
+[heading Requirements]
-[heading Parameters]
-
+[*Header: ][^boost/asio/ssl/stream.hpp]
-[variablelist
-
-[[filename][The name of a file containing certification authority certificates in PEM format.]]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[endsect]
-[heading Remarks]
-
-Calls `SSL_CTX_load_verify_locations`.
+[section:native_handle ssl::stream::native_handle]
+[indexterm2 native_handle..ssl::stream]
+Get the underlying implementation in the native type.
-[endsect]
+ native_handle_type native_handle();
-[endsect]
+This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
-[section:method ssl::context::method]
+[heading Example]
+
+The `native_handle()` function returns a pointer of type `SSL*` that is suitable for passing to functions such as `SSL_get_verify_result` and `SSL_get_peer_certificate:`
-[indexterm2 method..ssl::context]
-Different methods supported by a context.
+ boost::asio::ssl::stream<asio:ip::tcp::socket> sock(io_service, ctx);
+ // ... establish connection and perform handshake ...
- enum method
+ if (X509* cert = SSL_get_peer_certificate(sock.native_handle()))
+ {
+ if (SSL_get_verify_result(sock.native_handle()) == X509_V_OK)
+ {
+ // ...
+ }
+ }
-[indexterm2 sslv2..ssl::context]
-[indexterm2 sslv2_client..ssl::context]
-[indexterm2 sslv2_server..ssl::context]
-[indexterm2 sslv3..ssl::context]
-[indexterm2 sslv3_client..ssl::context]
-[indexterm2 sslv3_server..ssl::context]
-[indexterm2 tlsv1..ssl::context]
-[indexterm2 tlsv1_client..ssl::context]
-[indexterm2 tlsv1_server..ssl::context]
-[indexterm2 sslv23..ssl::context]
-[indexterm2 sslv23_client..ssl::context]
-[indexterm2 sslv23_server..ssl::context]
-[heading Values]
-[variablelist
- [
- [sslv2]
- [Generic SSL version 2. ]
- ]
- [
- [sslv2_client]
- [SSL version 2 client. ]
- ]
- [
- [sslv2_server]
- [SSL version 2 server. ]
- ]
- [
- [sslv3]
- [Generic SSL version 3. ]
- ]
- [
- [sslv3_client]
- [SSL version 3 client. ]
- ]
+[endsect]
- [
- [sslv3_server]
- [SSL version 3 server. ]
- ]
- [
- [tlsv1]
- [Generic TLS version 1. ]
- ]
- [
- [tlsv1_client]
- [TLS version 1 client. ]
- ]
+[section:native_handle_type ssl::stream::native_handle_type]
- [
- [tlsv1_server]
- [TLS version 1 server. ]
- ]
+[indexterm2 native_handle_type..ssl::stream]
+The native handle type of the SSL stream.
- [
- [sslv23]
- [Generic SSL/TLS. ]
- ]
- [
- [sslv23_client]
- [SSL/TLS client. ]
- ]
+ typedef SSL * native_handle_type;
- [
- [sslv23_server]
- [SSL/TLS server. ]
- ]
-]
+[heading Requirements]
+
+[*Header: ][^boost/asio/ssl/stream.hpp]
+
+[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
+[section:next_layer ssl::stream::next_layer]
-[section:native_handle ssl::context::native_handle]
+[indexterm2 next_layer..ssl::stream]
+Get a reference to the next layer.
-[indexterm2 native_handle..ssl::context]
-Get the underlying implementation in the native type.
+ const next_layer_type & ``[link boost_asio.reference.ssl__stream.next_layer.overload1 next_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.ssl__stream.next_layer.overload1 more...]]``
+
+ next_layer_type & ``[link boost_asio.reference.ssl__stream.next_layer.overload2 next_layer]``();
+ `` [''''»''' [link boost_asio.reference.ssl__stream.next_layer.overload2 more...]]``
- native_handle_type native_handle();
+[section:overload1 ssl::stream::next_layer (1 of 2 overloads)]
-This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
+Get a reference to the next layer.
-[endsect]
+ const next_layer_type & next_layer() const;
-[section:native_handle_type ssl::context::native_handle_type]
+This function returns a reference to the next layer in a stack of stream layers.
-[indexterm2 native_handle_type..ssl::context]
-The native handle type of the SSL context.
+
+[heading Return Value]
+
+A reference to the next layer in the stack of stream layers. Ownership is not transferred to the caller.
- typedef SSL_CTX * native_handle_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/context.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:overload2 ssl::stream::next_layer (2 of 2 overloads)]
-[endsect]
+Get a reference to the next layer.
+ next_layer_type & next_layer();
-[section:no_sslv2 ssl::context::no_sslv2]
-[indexterm2 no_sslv2..ssl::context]
-Disable SSL v2.
+This function returns a reference to the next layer in a stack of stream layers.
- static const int no_sslv2 = implementation_defined;
+[heading Return Value]
+
+A reference to the next layer in the stack of stream layers. Ownership is not transferred to the caller.
+
[endsect]
+[endsect]
-[section:no_sslv3 ssl::context::no_sslv3]
-[indexterm2 no_sslv3..ssl::context]
-Disable SSL v3.
+[section:next_layer_type ssl::stream::next_layer_type]
+[indexterm2 next_layer_type..ssl::stream]
+The type of the next layer.
- static const int no_sslv3 = implementation_defined;
+ typedef boost::remove_reference< Stream >::type next_layer_type;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/stream.hpp]
-[section:no_tlsv1 ssl::context::no_tlsv1]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[indexterm2 no_tlsv1..ssl::context]
-Disable TLS v1.
+[endsect]
- static const int no_tlsv1 = implementation_defined;
+[section:read_some ssl::stream::read_some]
+[indexterm2 read_some..ssl::stream]
+Read some data from the stream.
-[endsect]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.ssl__stream.read_some.overload1 read_some]``(
+ const MutableBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.read_some.overload1 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.ssl__stream.read_some.overload2 read_some]``(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.read_some.overload2 more...]]``
-[section:operator_eq_ ssl::context::operator=]
-[indexterm2 operator=..ssl::context]
-Move-assign a context from another.
+[section:overload1 ssl::stream::read_some (1 of 2 overloads)]
- context & operator=(
- context && other);
+Read some data from the stream.
-This assignment operator moves an SSL context from one object to another.
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers);
+
+
+This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
[heading Parameters]
@@ -81577,103 +85551,132 @@
[variablelist
-[[other][The other context object from which the move will occur.]]
+[[buffers][The buffers into which the data will be read.]]
]
-[heading Remarks]
+[heading Return Value]
-Following the move, the following operations only are valid for the moved-from object:
-* Destruction.
+The number of bytes read.
-* As a target for move-assignment.
+[heading Exceptions]
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure.]]
+]
+[heading Remarks]
+
+The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
-[endsect]
-[section:options ssl::context::options]
+[endsect]
-[indexterm2 options..ssl::context]
-Bitmask type for SSL options.
- typedef int options;
+[section:overload2 ssl::stream::read_some (2 of 2 overloads)]
+Read some data from the stream.
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/context.hpp]
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t read_some(
+ const MutableBufferSequence & buffers,
+ boost::system::error_code & ec);
-[*Convenience header: ][^boost/asio/ssl.hpp]
+This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[buffers][The buffers into which the data will be read.]]
-[section:password_purpose ssl::context::password_purpose]
+[[ec][Set to indicate what error occurred, if any.]]
-[indexterm2 password_purpose..ssl::context]
-Purpose of PEM password.
+]
- enum password_purpose
+[heading Return Value]
+
+The number of bytes read. Returns 0 if an error occurred.
-[indexterm2 for_reading..ssl::context]
-[indexterm2 for_writing..ssl::context]
-[heading Values]
-[variablelist
+[heading Remarks]
+
+The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
- [
- [for_reading]
- [The password is needed for reading/decryption. ]
- ]
- [
- [for_writing]
- [The password is needed for writing/encryption. ]
- ]
-]
+[endsect]
[endsect]
+[section:set_verify_callback ssl::stream::set_verify_callback]
-[section:set_default_verify_paths ssl::context::set_default_verify_paths]
-
-[indexterm2 set_default_verify_paths..ssl::context]
-Configures the context to use the default directories for finding certification authority certificates.
+[indexterm2 set_verify_callback..ssl::stream]
+Set the callback used to verify peer certificates.
- void ``[link boost_asio.reference.ssl__context.set_default_verify_paths.overload1 set_default_verify_paths]``();
- `` [''''»''' [link boost_asio.reference.ssl__context.set_default_verify_paths.overload1 more...]]``
+ template<
+ typename VerifyCallback>
+ void ``[link boost_asio.reference.ssl__stream.set_verify_callback.overload1 set_verify_callback]``(
+ VerifyCallback callback);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_callback.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__context.set_default_verify_paths.overload2 set_default_verify_paths]``(
+ template<
+ typename VerifyCallback>
+ boost::system::error_code ``[link boost_asio.reference.ssl__stream.set_verify_callback.overload2 set_verify_callback]``(
+ VerifyCallback callback,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_default_verify_paths.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_callback.overload2 more...]]``
-[section:overload1 ssl::context::set_default_verify_paths (1 of 2 overloads)]
+[section:overload1 ssl::stream::set_verify_callback (1 of 2 overloads)]
-Configures the context to use the default directories for finding certification authority certificates.
+Set the callback used to verify peer certificates.
- void set_default_verify_paths();
+ template<
+ typename VerifyCallback>
+ void set_verify_callback(
+ VerifyCallback callback);
-This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
+This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
+``
+ bool verify_callback(
+ bool preverified, // True if the certificate passed pre-verification.
+ verify_context& ctx // The peer certificate and other context.
+ );
+``
+The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+
+]
[heading Exceptions]
@@ -81688,7 +85691,7 @@
[heading Remarks]
-Calls `SSL_CTX_set_default_verify_paths`.
+Calls `SSL_set_verify`.
@@ -81697,17 +85700,20 @@
-[section:overload2 ssl::context::set_default_verify_paths (2 of 2 overloads)]
+[section:overload2 ssl::stream::set_verify_callback (2 of 2 overloads)]
-Configures the context to use the default directories for finding certification authority certificates.
+Set the callback used to verify peer certificates.
- boost::system::error_code set_default_verify_paths(
+ template<
+ typename VerifyCallback>
+ boost::system::error_code set_verify_callback(
+ VerifyCallback callback,
boost::system::error_code & ec);
-This function specifies that the context should use the default, system-dependent directories for locating certification authority certificates.
+This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
[heading Parameters]
@@ -81715,6 +85721,15 @@
[variablelist
+[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
+``
+ bool verify_callback(
+ bool preverified, // True if the certificate passed pre-verification.
+ verify_context& ctx // The peer certificate and other context.
+ );
+``
+The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+
[[ec][Set to indicate what error occurred, if any.]]
]
@@ -81722,7 +85737,7 @@
[heading Remarks]
-Calls `SSL_CTX_set_default_verify_paths`.
+Calls `SSL_set_verify`.
@@ -81732,33 +85747,33 @@
[endsect]
-[section:set_options ssl::context::set_options]
+[section:set_verify_mode ssl::stream::set_verify_mode]
-[indexterm2 set_options..ssl::context]
-Set options on the context.
+[indexterm2 set_verify_mode..ssl::stream]
+Set the peer verification mode.
- void ``[link boost_asio.reference.ssl__context.set_options.overload1 set_options]``(
- options o);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_options.overload1 more...]]``
+ void ``[link boost_asio.reference.ssl__stream.set_verify_mode.overload1 set_verify_mode]``(
+ verify_mode v);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_mode.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__context.set_options.overload2 set_options]``(
- options o,
+ boost::system::error_code ``[link boost_asio.reference.ssl__stream.set_verify_mode.overload2 set_verify_mode]``(
+ verify_mode v,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_options.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_mode.overload2 more...]]``
-[section:overload1 ssl::context::set_options (1 of 2 overloads)]
+[section:overload1 ssl::stream::set_verify_mode (1 of 2 overloads)]
-Set options on the context.
+Set the peer verification mode.
- void set_options(
- options o);
+ void set_verify_mode(
+ verify_mode v);
-This function may be used to configure the SSL options used by the context.
+This function may be used to configure the peer verification mode used by the stream. The new mode will override the mode inherited from the context.
[heading Parameters]
@@ -81766,7 +85781,7 @@
[variablelist
-[[o][A bitmask of options. The available option values are defined in the [link boost_asio.reference.ssl__context_base `ssl::context_base`] class. The options are bitwise-ored with any existing value for the options.]]
+[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
]
@@ -81783,7 +85798,7 @@
[heading Remarks]
-Calls `SSL_CTX_set_options`.
+Calls `SSL_set_verify`.
@@ -81792,18 +85807,18 @@
-[section:overload2 ssl::context::set_options (2 of 2 overloads)]
+[section:overload2 ssl::stream::set_verify_mode (2 of 2 overloads)]
-Set options on the context.
+Set the peer verification mode.
- boost::system::error_code set_options(
- options o,
+ boost::system::error_code set_verify_mode(
+ verify_mode v,
boost::system::error_code & ec);
-This function may be used to configure the SSL options used by the context.
+This function may be used to configure the peer verification mode used by the stream. The new mode will override the mode inherited from the context.
[heading Parameters]
@@ -81811,7 +85826,7 @@
[variablelist
-[[o][A bitmask of options. The available option values are defined in the [link boost_asio.reference.ssl__context_base `ssl::context_base`] class. The options are bitwise-ored with any existing value for the options.]]
+[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
[[ec][Set to indicate what error occurred, if any.]]
@@ -81820,7 +85835,7 @@
[heading Remarks]
-Calls `SSL_CTX_set_options`.
+Calls `SSL_set_verify`.
@@ -81830,93 +85845,93 @@
[endsect]
-[section:set_password_callback ssl::context::set_password_callback]
+[section:shutdown ssl::stream::shutdown]
-[indexterm2 set_password_callback..ssl::context]
-Set the password callback.
+[indexterm2 shutdown..ssl::stream]
+Shut down SSL on the stream.
- template<
- typename PasswordCallback>
- void ``[link boost_asio.reference.ssl__context.set_password_callback.overload1 set_password_callback]``(
- PasswordCallback callback);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_password_callback.overload1 more...]]``
+ void ``[link boost_asio.reference.ssl__stream.shutdown.overload1 shutdown]``();
+ `` [''''»''' [link boost_asio.reference.ssl__stream.shutdown.overload1 more...]]``
- template<
- typename PasswordCallback>
- boost::system::error_code ``[link boost_asio.reference.ssl__context.set_password_callback.overload2 set_password_callback]``(
- PasswordCallback callback,
+ boost::system::error_code ``[link boost_asio.reference.ssl__stream.shutdown.overload2 shutdown]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_password_callback.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.ssl__stream.shutdown.overload2 more...]]``
-[section:overload1 ssl::context::set_password_callback (1 of 2 overloads)]
+[section:overload1 ssl::stream::shutdown (1 of 2 overloads)]
-Set the password callback.
+Shut down SSL on the stream.
- template<
- typename PasswordCallback>
- void set_password_callback(
- PasswordCallback callback);
+ void shutdown();
-This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.
+This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.
-[heading Parameters]
+[heading Exceptions]
[variablelist
-[[callback][The function object to be used for obtaining the password. The function signature of the handler must be:
-``
- std::string password_callback(
- std::size_t max_length, // The maximum size for a password.
- password_purpose purpose // Whether password is for reading or writing.
- );
-``
-The return value of the callback is a string containing the password.]]
+[[boost::system::system_error][Thrown on failure. ]]
]
-[heading Exceptions]
+
+
+[endsect]
+
+
+
+[section:overload2 ssl::stream::shutdown (2 of 2 overloads)]
+
+
+Shut down SSL on the stream.
+
+
+ boost::system::error_code shutdown(
+ boost::system::error_code & ec);
+
+
+This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.
+
+
+[heading Parameters]
[variablelist
-[[boost::system::system_error][Thrown on failure.]]
+[[ec][Set to indicate what error occurred, if any. ]]
]
-[heading Remarks]
-
-Calls `SSL_CTX_set_default_passwd_cb`.
-
-
[endsect]
+[endsect]
-[section:overload2 ssl::context::set_password_callback (2 of 2 overloads)]
+[section:stream ssl::stream::stream]
-Set the password callback.
+[indexterm2 stream..ssl::stream]
+Construct a stream.
template<
- typename PasswordCallback>
- boost::system::error_code set_password_callback(
- PasswordCallback callback,
- boost::system::error_code & ec);
+ typename Arg>
+ stream(
+ Arg & arg,
+ context & ctx);
-This function is used to specify a callback function to obtain password information about an encrypted key in PEM format.
+This constructor creates a stream and initialises the underlying stream object.
[heading Parameters]
@@ -81924,65 +85939,51 @@
[variablelist
-[[callback][The function object to be used for obtaining the password. The function signature of the handler must be:
-``
- std::string password_callback(
- std::size_t max_length, // The maximum size for a password.
- password_purpose purpose // Whether password is for reading or writing.
- );
-``
-The return value of the callback is a string containing the password.]]
+[[arg][The argument to be passed to initialise the underlying stream.]]
-[[ec][Set to indicate what error occurred, if any.]]
+[[ctx][The SSL context to be used for the stream. ]]
]
-[heading Remarks]
-
-Calls `SSL_CTX_set_default_passwd_cb`.
-
-
[endsect]
-[endsect]
-
-[section:set_verify_callback ssl::context::set_verify_callback]
+[section:write_some ssl::stream::write_some]
-[indexterm2 set_verify_callback..ssl::context]
-Set the callback used to verify peer certificates.
+[indexterm2 write_some..ssl::stream]
+Write some data to the stream.
template<
- typename VerifyCallback>
- void ``[link boost_asio.reference.ssl__context.set_verify_callback.overload1 set_verify_callback]``(
- VerifyCallback callback);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_callback.overload1 more...]]``
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.ssl__stream.write_some.overload1 write_some]``(
+ const ConstBufferSequence & buffers);
+ `` [''''»''' [link boost_asio.reference.ssl__stream.write_some.overload1 more...]]``
template<
- typename VerifyCallback>
- boost::system::error_code ``[link boost_asio.reference.ssl__context.set_verify_callback.overload2 set_verify_callback]``(
- VerifyCallback callback,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t ``[link boost_asio.reference.ssl__stream.write_some.overload2 write_some]``(
+ const ConstBufferSequence & buffers,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_callback.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.ssl__stream.write_some.overload2 more...]]``
-[section:overload1 ssl::context::set_verify_callback (1 of 2 overloads)]
+[section:overload1 ssl::stream::write_some (1 of 2 overloads)]
-Set the callback used to verify peer certificates.
+Write some data to the stream.
template<
- typename VerifyCallback>
- void set_verify_callback(
- VerifyCallback callback);
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers);
-This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
+This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.
[heading Parameters]
@@ -81990,18 +85991,16 @@
[variablelist
-[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
-``
- bool verify_callback(
- bool preverified, // True if the certificate passed pre-verification.
- verify_context& ctx // The peer certificate and other context.
- );
-``
-The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+[[buffers][The data to be written.]]
]
+[heading Return Value]
+
+The number of bytes written.
+
+
[heading Exceptions]
@@ -82014,7 +86013,7 @@
[heading Remarks]
-Calls `SSL_CTX_set_verify`.
+The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
@@ -82023,20 +86022,20 @@
-[section:overload2 ssl::context::set_verify_callback (2 of 2 overloads)]
+[section:overload2 ssl::stream::write_some (2 of 2 overloads)]
-Set the callback used to verify peer certificates.
+Write some data to the stream.
template<
- typename VerifyCallback>
- boost::system::error_code set_verify_callback(
- VerifyCallback callback,
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t write_some(
+ const ConstBufferSequence & buffers,
boost::system::error_code & ec);
-This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
+This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.
[heading Parameters]
@@ -82044,23 +86043,21 @@
[variablelist
-[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
-``
- bool verify_callback(
- bool preverified, // True if the certificate passed pre-verification.
- verify_context& ctx // The peer certificate and other context.
- );
-``
-The return value of the callback is true if the certificate has passed verification, false otherwise.]]
+[[buffers][The data to be written to the stream.]]
[[ec][Set to indicate what error occurred, if any.]]
]
+[heading Return Value]
+
+The number of bytes written. Returns 0 if an error occurred.
+
+
[heading Remarks]
-Calls `SSL_CTX_set_verify`.
+The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
@@ -82070,59 +86067,55 @@
[endsect]
-[section:set_verify_mode ssl::context::set_verify_mode]
-[indexterm2 set_verify_mode..ssl::context]
-Set the peer verification mode.
+[section:_stream ssl::stream::~stream]
+
+[indexterm2 ~stream..ssl::stream]
+Destructor.
- void ``[link boost_asio.reference.ssl__context.set_verify_mode.overload1 set_verify_mode]``(
- verify_mode v);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_mode.overload1 more...]]``
+ ~stream();
- boost::system::error_code ``[link boost_asio.reference.ssl__context.set_verify_mode.overload2 set_verify_mode]``(
- verify_mode v,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.set_verify_mode.overload2 more...]]``
-[section:overload1 ssl::context::set_verify_mode (1 of 2 overloads)]
+[endsect]
-Set the peer verification mode.
+[endsect]
- void set_verify_mode(
- verify_mode v);
+[section:ssl__stream__impl_struct ssl::stream::impl_struct]
-This function may be used to configure the peer verification mode used by the context.
+Structure for use with deprecated impl\_type.
-[heading Parameters]
-
+ struct impl_struct
-[variablelist
-
-[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.ssl__stream__impl_struct.ssl [*ssl]]]
+ []
+ ]
]
+[heading Requirements]
-[heading Exceptions]
-
+[*Header: ][^boost/asio/ssl/stream.hpp]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-]
+[section:ssl ssl::stream::impl_struct::ssl]
-[heading Remarks]
-
-Calls `SSL_CTX_set_verify`.
+[indexterm2 ssl..ssl::stream::impl_struct]
+ SSL * ssl;
@@ -82130,596 +86123,701 @@
-[section:overload2 ssl::context::set_verify_mode (2 of 2 overloads)]
+[endsect]
+[section:ssl__stream_base ssl::stream_base]
-Set the peer verification mode.
+The [link boost_asio.reference.ssl__stream_base `ssl::stream_base`] class is used as a base for the [link boost_asio.reference.ssl__stream `ssl::stream`] class template so that we have a common place to define various enums.
- boost::system::error_code set_verify_mode(
- verify_mode v,
- boost::system::error_code & ec);
+ class stream_base
-This function may be used to configure the peer verification mode used by the context.
+[heading Types]
+[table
+ [[Name][Description]]
-[heading Parameters]
-
+ [
-[variablelist
+ [[link boost_asio.reference.ssl__stream_base.handshake_type [*handshake_type]]]
+ [Different handshake types. ]
-[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
+ ]
-[[ec][Set to indicate what error occurred, if any.]]
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ssl__stream_base._stream_base [*~stream_base]]]
+ [Protected destructor to prevent deletion through this type. ]
+ ]
+
]
+[heading Requirements]
-[heading Remarks]
-
-Calls `SSL_CTX_set_verify`.
+[*Header: ][^boost/asio/ssl/stream_base.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:handshake_type ssl::stream_base::handshake_type]
-[endsect]
+[indexterm2 handshake_type..ssl::stream_base]
+Different handshake types.
-[endsect]
+ enum handshake_type
+[indexterm2 client..ssl::stream_base]
+[indexterm2 server..ssl::stream_base]
-[section:single_dh_use ssl::context::single_dh_use]
+[heading Values]
+[variablelist
-[indexterm2 single_dh_use..ssl::context]
-Always create a new key when using tmp\_dh parameters.
+ [
+ [client]
+ [Perform handshaking as a client. ]
+ ]
+ [
+ [server]
+ [Perform handshaking as a server. ]
+ ]
- static const int single_dh_use = implementation_defined;
+]
[endsect]
-[section:use_certificate_chain_file ssl::context::use_certificate_chain_file]
-[indexterm2 use_certificate_chain_file..ssl::context]
-Use a certificate chain from a file.
+[section:_stream_base ssl::stream_base::~stream_base]
+[indexterm2 ~stream_base..ssl::stream_base]
+Protected destructor to prevent deletion through this type.
- void ``[link boost_asio.reference.ssl__context.use_certificate_chain_file.overload1 use_certificate_chain_file]``(
- const std::string & filename);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_chain_file.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__context.use_certificate_chain_file.overload2 use_certificate_chain_file]``(
- const std::string & filename,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_chain_file.overload2 more...]]``
+ ~stream_base();
-[section:overload1 ssl::context::use_certificate_chain_file (1 of 2 overloads)]
+[endsect]
-Use a certificate chain from a file.
- void use_certificate_chain_file(
- const std::string & filename);
+[endsect]
-This function is used to load a certificate chain into the context from a file.
+[section:ssl__verify_client_once ssl::verify_client_once]
+[indexterm1 ssl::verify_client_once]
+Do not request client certificate on renegotiation. Ignored unless [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`] is set.
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the certificate. The file must use the PEM format.]]
+ const int verify_client_once = implementation_defined;
-]
+[heading Requirements]
-[heading Exceptions]
-
+[*Header: ][^boost/asio/ssl/verify_mode.hpp]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-]
+[endsect]
-[heading Remarks]
-
-Calls `SSL_CTX_use_certificate_chain_file`.
+[section:ssl__verify_context ssl::verify_context]
+A simple wrapper around the X509\_STORE\_CTX type, used during verification of a peer certificate.
-[endsect]
+ class verify_context :
+ noncopyable
-[section:overload2 ssl::context::use_certificate_chain_file (2 of 2 overloads)]
+[heading Types]
+[table
+ [[Name][Description]]
+ [
-Use a certificate chain from a file.
+ [[link boost_asio.reference.ssl__verify_context.native_handle_type [*native_handle_type]]]
+ [The native handle type of the verification context. ]
+
+ ]
+]
- boost::system::error_code use_certificate_chain_file(
- const std::string & filename,
- boost::system::error_code & ec);
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.ssl__verify_context.native_handle [*native_handle]]]
+ [Get the underlying implementation in the native type. ]
+ ]
+
+ [
+ [[link boost_asio.reference.ssl__verify_context.verify_context [*verify_context]]]
+ [Constructor. ]
+ ]
+
+]
-This function is used to load a certificate chain into the context from a file.
+[heading Remarks]
+
+The [link boost_asio.reference.ssl__verify_context `ssl::verify_context`] does not own the underlying X509\_STORE\_CTX object.
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the certificate. The file must use the PEM format.]]
-[[ec][Set to indicate what error occurred, if any.]]
+[heading Requirements]
-]
+[*Header: ][^boost/asio/ssl/verify_context.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[heading Remarks]
-
-Calls `SSL_CTX_use_certificate_chain_file`.
+[section:native_handle ssl::verify_context::native_handle]
+[indexterm2 native_handle..ssl::verify_context]
+Get the underlying implementation in the native type.
-[endsect]
+ native_handle_type native_handle();
+
+
+This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
[endsect]
-[section:use_certificate_file ssl::context::use_certificate_file]
-[indexterm2 use_certificate_file..ssl::context]
-Use a certificate from a file.
+[section:native_handle_type ssl::verify_context::native_handle_type]
- void ``[link boost_asio.reference.ssl__context.use_certificate_file.overload1 use_certificate_file]``(
- const std::string & filename,
- file_format format);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_file.overload1 more...]]``
+[indexterm2 native_handle_type..ssl::verify_context]
+The native handle type of the verification context.
- boost::system::error_code ``[link boost_asio.reference.ssl__context.use_certificate_file.overload2 use_certificate_file]``(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_certificate_file.overload2 more...]]``
+ typedef X509_STORE_CTX * native_handle_type;
-[section:overload1 ssl::context::use_certificate_file (1 of 2 overloads)]
-Use a certificate from a file.
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/verify_context.hpp]
- void use_certificate_file(
- const std::string & filename,
- file_format format);
+[*Convenience header: ][^boost/asio/ssl.hpp]
-This function is used to load a certificate into the context from a file.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the certificate.]]
+[section:verify_context ssl::verify_context::verify_context]
-[[format][The file format (ASN.1 or PEM).]]
+[indexterm2 verify_context..ssl::verify_context]
+Constructor.
-]
+ verify_context(
+ native_handle_type handle);
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+[endsect]
-[heading Remarks]
-
-Calls `SSL_CTX_use_certificate_file`.
+[endsect]
+[section:ssl__verify_fail_if_no_peer_cert ssl::verify_fail_if_no_peer_cert]
-[endsect]
+[indexterm1 ssl::verify_fail_if_no_peer_cert]
+Fail verification if the peer has no certificate. Ignored unless [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`] is set.
+ const int verify_fail_if_no_peer_cert = implementation_defined;
-[section:overload2 ssl::context::use_certificate_file (2 of 2 overloads)]
+[heading Requirements]
-Use a certificate from a file.
+[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
- boost::system::error_code use_certificate_file(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
+[endsect]
-This function is used to load a certificate into the context from a file.
-[heading Parameters]
-
+[section:ssl__verify_mode ssl::verify_mode]
-[variablelist
-
-[[filename][The name of the file containing the certificate.]]
+[indexterm1 ssl::verify_mode]
+Bitmask type for peer verification.
-[[format][The file format (ASN.1 or PEM).]]
-[[ec][Set to indicate what error occurred, if any.]]
+ typedef int verify_mode;
-]
-[heading Remarks]
-
-Calls `SSL_CTX_use_certificate_file`.
+Possible values are:
+* [link boost_asio.reference.ssl__verify_none `ssl::verify_none`]
+* [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`]
-[endsect]
+* [link boost_asio.reference.ssl__verify_fail_if_no_peer_cert `ssl::verify_fail_if_no_peer_cert`]
+* [link boost_asio.reference.ssl__verify_client_once `ssl::verify_client_once`]
-[endsect]
-[section:use_private_key_file ssl::context::use_private_key_file]
-[indexterm2 use_private_key_file..ssl::context]
-Use a private key from a file.
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/verify_mode.hpp]
- void ``[link boost_asio.reference.ssl__context.use_private_key_file.overload1 use_private_key_file]``(
- const std::string & filename,
- file_format format);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_private_key_file.overload1 more...]]``
+[*Convenience header: ][^boost/asio/ssl.hpp]
- boost::system::error_code ``[link boost_asio.reference.ssl__context.use_private_key_file.overload2 use_private_key_file]``(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_private_key_file.overload2 more...]]``
+
+[endsect]
-[section:overload1 ssl::context::use_private_key_file (1 of 2 overloads)]
+[section:ssl__verify_none ssl::verify_none]
+
+[indexterm1 ssl::verify_none]
+No verification.
-Use a private key from a file.
+ const int verify_none = implementation_defined;
- void use_private_key_file(
- const std::string & filename,
- file_format format);
+[heading Requirements]
-This function is used to load a private key into the context from a file.
+[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the private key.]]
+[endsect]
-[[format][The file format (ASN.1 or PEM).]]
-]
+[section:ssl__verify_peer ssl::verify_peer]
-[heading Exceptions]
-
+[indexterm1 ssl::verify_peer]
+Verify the peer.
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+ const int verify_peer = implementation_defined;
-[heading Remarks]
-
-Calls `SSL_CTX_use_PrivateKey_file`.
+[heading Requirements]
+[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
-[section:overload2 ssl::context::use_private_key_file (2 of 2 overloads)]
+[section:steady_timer steady_timer]
+[indexterm1 steady_timer]
+Typedef for a timer based on the steady clock.
-Use a private key from a file.
+ typedef basic_waitable_timer< chrono::steady_clock > steady_timer;
- boost::system::error_code use_private_key_file(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
+[heading Types]
+[table
+ [[Name][Description]]
-This function is used to load a private key into the context from a file.
+ [
+ [[link boost_asio.reference.basic_waitable_timer.clock_type [*clock_type]]]
+ [The clock type. ]
+
+ ]
-[heading Parameters]
-
+ [
-[variablelist
+ [[link boost_asio.reference.basic_waitable_timer.duration [*duration]]]
+ [The duration type of the clock. ]
-[[filename][The name of the file containing the private key.]]
+ ]
-[[format][The file format (ASN.1 or PEM).]]
+ [
-[[ec][Set to indicate what error occurred, if any.]]
+ [[link boost_asio.reference.basic_waitable_timer.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
-]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
-[heading Remarks]
-
-Calls `SSL_CTX_use_PrivateKey_file`.
+ [
+ [[link boost_asio.reference.basic_waitable_timer.time_point [*time_point]]]
+ [The time point type of the clock. ]
+
+ ]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.traits_type [*traits_type]]]
+ [The wait traits type. ]
+
+ ]
-[endsect]
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[endsect]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer [*basic_waitable_timer]]]
+ [Constructor.
-[section:use_rsa_private_key_file ssl::context::use_rsa_private_key_file]
+ Constructor to set a particular expiry time as an absolute time.
-[indexterm2 use_rsa_private_key_file..ssl::context]
-Use an RSA private key from a file.
+ Constructor to set a particular expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous operation that is waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_at [*expires_at]]]
+ [Get the timer's expiry time as an absolute time.
+ Set the timer's expiry time as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
- void ``[link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload1 use_rsa_private_key_file]``(
- const std::string & filename,
- file_format format);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload1 more...]]``
+ Set the timer's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.wait [*wait]]]
+ [Perform a blocking wait on the timer. ]
+ ]
+
+]
- boost::system::error_code ``[link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2 use_rsa_private_key_file]``(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_rsa_private_key_file.overload2 more...]]``
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
-[section:overload1 ssl::context::use_rsa_private_key_file (1 of 2 overloads)]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-Use an RSA private key from a file.
+ [
+ [[link boost_asio.reference.basic_waitable_timer.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
- void use_rsa_private_key_file(
- const std::string & filename,
- file_format format);
+The [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
+A waitable timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
-This function is used to load an RSA private key into the context from a file.
+Most applications will use the boost::asio::waitable\_timer typedef.
-[heading Parameters]
-
+[heading Remarks]
+
+This waitable timer functionality is for use with the C++11 standard library's `<chrono>` facility, or with the Boost.Chrono library.
-[variablelist
+
+[heading Thread Safety]
-[[filename][The name of the file containing the RSA private key.]]
+[*Distinct] [*objects:] Safe.
-[[format][The file format (ASN.1 or PEM).]]
+[*Shared] [*objects:] Unsafe.
-]
+[heading Examples]
+
+Performing a blocking wait:
-[heading Exceptions]
-
+ // Construct a timer without setting an expiry time.
+ boost::asio::waitable_timer timer(io_service);
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+ // Set an expiry time relative to now.
+ timer.expires_from_now(boost::posix_time::seconds(5));
-]
+ // Wait for the timer to expire.
+ timer.wait();
-[heading Remarks]
-
-Calls `SSL_CTX_use_RSAPrivateKey_file`.
+Performing an asynchronous wait:
-[endsect]
+ void handler(const boost::system::error_code& error)
+ {
+ if (!error)
+ {
+ // Timer expired.
+ }
+ }
+ ...
+ // Construct a timer with an absolute expiry time.
+ boost::asio::waitable_timer timer(io_service,
+ boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
-[section:overload2 ssl::context::use_rsa_private_key_file (2 of 2 overloads)]
+ // Start an asynchronous wait.
+ timer.async_wait(handler);
-Use an RSA private key from a file.
- boost::system::error_code use_rsa_private_key_file(
- const std::string & filename,
- file_format format,
- boost::system::error_code & ec);
+[heading Changing an active waitable_timer's expiry time]
+
-This function is used to load an RSA private key into the context from a file.
+Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the RSA private key.]]
-[[format][The file format (ASN.1 or PEM).]]
+ void on_some_event()
+ {
+ if (my_timer.expires_from_now(seconds(5)) > 0)
+ {
+ // We managed to cancel the timer. Start new asynchronous wait.
+ my_timer.async_wait(on_timeout);
+ }
+ else
+ {
+ // Too late, timer has already expired!
+ }
+ }
-[[ec][Set to indicate what error occurred, if any.]]
+ void on_timeout(const boost::system::error_code& e)
+ {
+ if (e != boost::asio::error::operation_aborted)
+ {
+ // Timer was not cancelled, take necessary action.
+ }
+ }
-]
-[heading Remarks]
-
-Calls `SSL_CTX_use_RSAPrivateKey_file`.
+* The `boost::asio::basic_waitable_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
-[endsect]
+* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
-[endsect]
-[section:use_tmp_dh_file ssl::context::use_tmp_dh_file]
-[indexterm2 use_tmp_dh_file..ssl::context]
-Use the specified file to obtain the temporary Diffie-Hellman parameters.
+This typedef uses the C++11 `<chrono>` standard library facility, if available. Otherwise, it may use the Boost.Chrono library. To explicitly utilise Boost.Chrono, use the [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] template directly:
+ typedef basic_waitable_timer<boost::chrono::steady_clock> timer;
- void ``[link boost_asio.reference.ssl__context.use_tmp_dh_file.overload1 use_tmp_dh_file]``(
- const std::string & filename);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_tmp_dh_file.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__context.use_tmp_dh_file.overload2 use_tmp_dh_file]``(
- const std::string & filename,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__context.use_tmp_dh_file.overload2 more...]]``
-[section:overload1 ssl::context::use_tmp_dh_file (1 of 2 overloads)]
+[heading Requirements]
+[*Header: ][^boost/asio/steady_timer.hpp]
-Use the specified file to obtain the temporary Diffie-Hellman parameters.
+[*Convenience header: ]None
- void use_tmp_dh_file(
- const std::string & filename);
+[endsect]
-This function is used to load Diffie-Hellman parameters into the context from a file.
+[section:strand strand]
-[heading Parameters]
-
+[indexterm1 strand]
+Typedef for backwards compatibility.
-[variablelist
-
-[[filename][The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.]]
-]
+ typedef boost::asio::io_service::strand strand;
-[heading Exceptions]
-
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[variablelist
+ [
+ [[link boost_asio.reference.io_service__strand.dispatch [*dispatch]]]
+ [Request the strand to invoke the given handler. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the strand. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.post [*post]]]
+ [Request the strand to invoke the given handler and return immediately. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.strand [*strand]]]
+ [Constructor. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand.wrap [*wrap]]]
+ [Create a new handler that automatically dispatches the wrapped handler on the strand. ]
+ ]
+
+ [
+ [[link boost_asio.reference.io_service__strand._strand [*~strand]]]
+ [Destructor. ]
+ ]
-[[boost::system::system_error][Thrown on failure.]]
-
]
+The [link boost_asio.reference.io_service__strand `io_service::strand`] class provides the ability to post and dispatch handlers with the guarantee that none of those handlers will execute concurrently.
-[heading Remarks]
-
-Calls `SSL_CTX_set_tmp_dh`.
+[heading Order of handler invocation]
+
+Given:
+* a strand object `s`
-[endsect]
+* an object `a` meeting completion handler requirements
-[section:overload2 ssl::context::use_tmp_dh_file (2 of 2 overloads)]
+* an object `a1` which is an arbitrary copy of `a` made by the implementation
-Use the specified file to obtain the temporary Diffie-Hellman parameters.
+* an object `b` meeting completion handler requirements
- boost::system::error_code use_tmp_dh_file(
- const std::string & filename,
- boost::system::error_code & ec);
+* an object `b1` which is an arbitrary copy of `b` made by the implementation
+if any of the following conditions are true:
-This function is used to load Diffie-Hellman parameters into the context from a file.
+* `s.post(a)` happens-before `s.post(b)`
-[heading Parameters]
-
-[variablelist
-
-[[filename][The name of the file containing the Diffie-Hellman parameters. The file must use the PEM format.]]
+* `s.post(a)` happens-before `s.dispatch(b)`, where the latter is performed outside the strand
-[[ec][Set to indicate what error occurred, if any.]]
-]
+* `s.dispatch(a)` happens-before `s.post(b)`, where the former is performed outside the strand
-[heading Remarks]
-
-Calls `SSL_CTX_set_tmp_dh`.
+* `s.dispatch(a)` happens-before `s.dispatch(b)`, where both are performed outside the strand
+then `asio_handler_invoke(a1, &a1)` happens-before `asio_handler_invoke(b1, &b1)`.
+Note that in the following case:
+ async_op_1(..., s.wrap(a));
+ async_op_2(..., s.wrap(b));
-[endsect]
+the completion of the first async operation will perform `s.dispatch(a)`, and the second will perform `s.dispatch(b)`, but the order in which those are performed is unspecified. That is, you cannot state whether one happens-before the other. Therefore none of the above conditions are met and no ordering guarantee is made.
-[endsect]
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
-[section:_context ssl::context::~context]
+[*Shared] [*objects:] Safe.
-[indexterm2 ~context..ssl::context]
-Destructor.
- ~context();
+[heading Requirements]
-[endsect]
+[*Header: ][^boost/asio/strand.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:ssl__context_base ssl::context_base]
+[section:stream_socket_service stream_socket_service]
-The [link boost_asio.reference.ssl__context_base `ssl::context_base`] class is used as a base for the basic\_context class template so that we have a common place to define various enums.
+Default service implementation for a stream socket.
- class context_base
+
+ template<
+ typename ``[link boost_asio.reference.Protocol Protocol]``>
+ class stream_socket_service :
+ public io_service::service
[heading Types]
@@ -82728,228 +86826,230 @@
[
- [[link boost_asio.reference.ssl__context_base.file_format [*file_format]]]
- [File format types. ]
+ [[link boost_asio.reference.stream_socket_service.endpoint_type [*endpoint_type]]]
+ [The endpoint type. ]
]
[
- [[link boost_asio.reference.ssl__context_base.method [*method]]]
- [Different methods supported by a context. ]
+ [[link boost_asio.reference.stream_socket_service.implementation_type [*implementation_type]]]
+ [The type of a stream socket implementation. ]
]
[
- [[link boost_asio.reference.ssl__context_base.options [*options]]]
- [Bitmask type for SSL options. ]
+ [[link boost_asio.reference.stream_socket_service.native_handle_type [*native_handle_type]]]
+ [The native socket type. ]
]
[
- [[link boost_asio.reference.ssl__context_base.password_purpose [*password_purpose]]]
- [Purpose of PEM password. ]
+ [[link boost_asio.reference.stream_socket_service.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native socket type. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.stream_socket_service.protocol_type [*protocol_type]]]
+ [The protocol type. ]
]
]
-[heading Protected Member Functions]
+[heading Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ssl__context_base._context_base [*~context_base]]]
- [Protected destructor to prevent deletion through this type. ]
+ [[link boost_asio.reference.stream_socket_service.assign [*assign]]]
+ [Assign an existing native socket to a stream socket. ]
]
-]
-
-[heading Data Members]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.ssl__context_base.default_workarounds [*default_workarounds]]]
- [Implement various bug workarounds. ]
+ [[link boost_asio.reference.stream_socket_service.async_connect [*async_connect]]]
+ [Start an asynchronous connect. ]
]
-
+
[
- [[link boost_asio.reference.ssl__context_base.no_sslv2 [*no_sslv2]]]
- [Disable SSL v2. ]
+ [[link boost_asio.reference.stream_socket_service.async_receive [*async_receive]]]
+ [Start an asynchronous receive. ]
]
-
+
[
- [[link boost_asio.reference.ssl__context_base.no_sslv3 [*no_sslv3]]]
- [Disable SSL v3. ]
+ [[link boost_asio.reference.stream_socket_service.async_send [*async_send]]]
+ [Start an asynchronous send. ]
]
-
+
[
- [[link boost_asio.reference.ssl__context_base.no_tlsv1 [*no_tlsv1]]]
- [Disable TLS v1. ]
+ [[link boost_asio.reference.stream_socket_service.at_mark [*at_mark]]]
+ [Determine whether the socket is at the out-of-band data mark. ]
]
-
+
[
- [[link boost_asio.reference.ssl__context_base.single_dh_use [*single_dh_use]]]
- [Always create a new key when using tmp_dh parameters. ]
+ [[link boost_asio.reference.stream_socket_service.available [*available]]]
+ [Determine the number of bytes available for reading. ]
]
-
-]
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ssl/context_base.hpp]
-
-[*Convenience header: ][^boost/asio/ssl.hpp]
-
-
-[section:default_workarounds ssl::context_base::default_workarounds]
-
-[indexterm2 default_workarounds..ssl::context_base]
-Implement various bug workarounds.
-
-
- static const int default_workarounds = implementation_defined;
-
-
-
-[endsect]
-
-
-
-[section:file_format ssl::context_base::file_format]
-
-[indexterm2 file_format..ssl::context_base]
-File format types.
-
-
- enum file_format
-
-[indexterm2 asn1..ssl::context_base]
-[indexterm2 pem..ssl::context_base]
-
-[heading Values]
-[variablelist
-
+
+ [
+ [[link boost_asio.reference.stream_socket_service.bind [*bind]]]
+ [Bind the stream socket to the specified local endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.close [*close]]]
+ [Close a stream socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.connect [*connect]]]
+ [Connect the stream socket to the specified endpoint. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.construct [*construct]]]
+ [Construct a new stream socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.destroy [*destroy]]]
+ [Destroy a stream socket implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.get_option [*get_option]]]
+ [Get a socket option. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.io_control [*io_control]]]
+ [Perform an IO control command on the socket. ]
+ ]
+
[
- [asn1]
- [ASN.1 file. ]
+ [[link boost_asio.reference.stream_socket_service.is_open [*is_open]]]
+ [Determine whether the socket is open. ]
]
-
+
[
- [pem]
- [PEM file. ]
+ [[link boost_asio.reference.stream_socket_service.local_endpoint [*local_endpoint]]]
+ [Get the local endpoint. ]
]
-
-]
-
-
-
-[endsect]
-
-
-
-[section:method ssl::context_base::method]
-
-[indexterm2 method..ssl::context_base]
-Different methods supported by a context.
-
-
- enum method
-
-[indexterm2 sslv2..ssl::context_base]
-[indexterm2 sslv2_client..ssl::context_base]
-[indexterm2 sslv2_server..ssl::context_base]
-[indexterm2 sslv3..ssl::context_base]
-[indexterm2 sslv3_client..ssl::context_base]
-[indexterm2 sslv3_server..ssl::context_base]
-[indexterm2 tlsv1..ssl::context_base]
-[indexterm2 tlsv1_client..ssl::context_base]
-[indexterm2 tlsv1_server..ssl::context_base]
-[indexterm2 sslv23..ssl::context_base]
-[indexterm2 sslv23_client..ssl::context_base]
-[indexterm2 sslv23_server..ssl::context_base]
-
-[heading Values]
-[variablelist
-
+
[
- [sslv2]
- [Generic SSL version 2. ]
+ [[link boost_asio.reference.stream_socket_service.move_assign [*move_assign]]]
+ [Move-assign from another stream socket implementation. ]
]
-
+
[
- [sslv2_client]
- [SSL version 2 client. ]
+ [[link boost_asio.reference.stream_socket_service.move_construct [*move_construct]]]
+ [Move-construct a new stream socket implementation. ]
]
-
+
[
- [sslv2_server]
- [SSL version 2 server. ]
+ [[link boost_asio.reference.stream_socket_service.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native socket implementation. ]
]
-
+
[
- [sslv3]
- [Generic SSL version 3. ]
+ [[link boost_asio.reference.stream_socket_service.native_handle [*native_handle]]]
+ [Get the native socket implementation. ]
]
-
+
[
- [sslv3_client]
- [SSL version 3 client. ]
+ [[link boost_asio.reference.stream_socket_service.native_non_blocking [*native_non_blocking]]]
+ [Gets the non-blocking mode of the native socket implementation.
+
+ Sets the non-blocking mode of the native socket implementation. ]
]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.non_blocking [*non_blocking]]]
+ [Gets the non-blocking mode of the socket.
+ Sets the non-blocking mode of the socket. ]
+ ]
+
[
- [sslv3_server]
- [SSL version 3 server. ]
+ [[link boost_asio.reference.stream_socket_service.open [*open]]]
+ [Open a stream socket. ]
]
-
+
[
- [tlsv1]
- [Generic TLS version 1. ]
+ [[link boost_asio.reference.stream_socket_service.receive [*receive]]]
+ [Receive some data from the peer. ]
]
-
+
[
- [tlsv1_client]
- [TLS version 1 client. ]
+ [[link boost_asio.reference.stream_socket_service.remote_endpoint [*remote_endpoint]]]
+ [Get the remote endpoint. ]
]
-
+
[
- [tlsv1_server]
- [TLS version 1 server. ]
+ [[link boost_asio.reference.stream_socket_service.send [*send]]]
+ [Send the given data to the peer. ]
]
-
+
[
- [sslv23]
- [Generic SSL/TLS. ]
+ [[link boost_asio.reference.stream_socket_service.set_option [*set_option]]]
+ [Set a socket option. ]
]
-
+
[
- [sslv23_client]
- [SSL/TLS client. ]
+ [[link boost_asio.reference.stream_socket_service.shutdown [*shutdown]]]
+ [Disable sends or receives on the socket. ]
+ ]
+
+ [
+ [[link boost_asio.reference.stream_socket_service.stream_socket_service [*stream_socket_service]]]
+ [Construct a new stream socket service for the specified io_service. ]
]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
[
- [sslv23_server]
- [SSL/TLS server. ]
+ [[link boost_asio.reference.stream_socket_service.id [*id]]]
+ [The unique service identifier. ]
]
]
+[heading Requirements]
+[*Header: ][^boost/asio/stream_socket_service.hpp]
-[endsect]
-
+[*Convenience header: ][^boost/asio.hpp]
-[section:no_sslv2 ssl::context_base::no_sslv2]
+[section:assign stream_socket_service::assign]
-[indexterm2 no_sslv2..ssl::context_base]
-Disable SSL v2.
+[indexterm2 assign..stream_socket_service]
+Assign an existing native socket to a stream socket.
- static const int no_sslv2 = implementation_defined;
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ const native_handle_type & native_socket,
+ boost::system::error_code & ec);
@@ -82957,13 +87057,18 @@
-[section:no_sslv3 ssl::context_base::no_sslv3]
+[section:async_connect stream_socket_service::async_connect]
-[indexterm2 no_sslv3..ssl::context_base]
-Disable SSL v3.
+[indexterm2 async_connect..stream_socket_service]
+Start an asynchronous connect.
- static const int no_sslv3 = implementation_defined;
+ template<
+ typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
+ void async_connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ ConnectHandler handler);
@@ -82971,13 +87076,20 @@
-[section:no_tlsv1 ssl::context_base::no_tlsv1]
+[section:async_receive stream_socket_service::async_receive]
-[indexterm2 no_tlsv1..ssl::context_base]
-Disable TLS v1.
+[indexterm2 async_receive..stream_socket_service]
+Start an asynchronous receive.
- static const int no_tlsv1 = implementation_defined;
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
+ typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
+ void async_receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ ReadHandler handler);
@@ -82985,52 +87097,52 @@
-[section:options ssl::context_base::options]
+[section:async_send stream_socket_service::async_send]
-[indexterm2 options..ssl::context_base]
-Bitmask type for SSL options.
+[indexterm2 async_send..stream_socket_service]
+Start an asynchronous send.
- typedef int options;
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
+ typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
+ void async_send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ WriteHandler handler);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ssl/context_base.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:at_mark stream_socket_service::at_mark]
-[endsect]
+[indexterm2 at_mark..stream_socket_service]
+Determine whether the socket is at the out-of-band data mark.
+ bool at_mark(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[section:password_purpose ssl::context_base::password_purpose]
-[indexterm2 password_purpose..ssl::context_base]
-Purpose of PEM password.
+[endsect]
- enum password_purpose
-[indexterm2 for_reading..ssl::context_base]
-[indexterm2 for_writing..ssl::context_base]
-[heading Values]
-[variablelist
+[section:available stream_socket_service::available]
- [
- [for_reading]
- [The password is needed for reading/decryption. ]
- ]
+[indexterm2 available..stream_socket_service]
+Determine the number of bytes available for reading.
- [
- [for_writing]
- [The password is needed for writing/encryption. ]
- ]
-]
+ std::size_t available(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
@@ -83038,13 +87150,16 @@
-[section:single_dh_use ssl::context_base::single_dh_use]
+[section:bind stream_socket_service::bind]
-[indexterm2 single_dh_use..ssl::context_base]
-Always create a new key when using tmp\_dh parameters.
+[indexterm2 bind..stream_socket_service]
+Bind the stream socket to the specified local endpoint.
- static const int single_dh_use = implementation_defined;
+ boost::system::error_code bind(
+ implementation_type & impl,
+ const endpoint_type & endpoint,
+ boost::system::error_code & ec);
@@ -83052,13 +87167,15 @@
-[section:_context_base ssl::context_base::~context_base]
+[section:cancel stream_socket_service::cancel]
-[indexterm2 ~context_base..ssl::context_base]
-Protected destructor to prevent deletion through this type.
+[indexterm2 cancel..stream_socket_service]
+Cancel all asynchronous operations associated with the socket.
- ~context_base();
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
@@ -83066,95 +87183,62 @@
-[endsect]
-
-[section:ssl__rfc2818_verification ssl::rfc2818_verification]
-
+[section:close stream_socket_service::close]
-Verifies a certificate against a hostname according to the rules described in RFC 2818.
+[indexterm2 close..stream_socket_service]
+Close a stream socket implementation.
- class rfc2818_verification
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.ssl__rfc2818_verification.result_type [*result_type]]]
- [The type of the function object's result. ]
-
- ]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
+[section:connect stream_socket_service::connect]
- [
- [[link boost_asio.reference.ssl__rfc2818_verification.operator_lp__rp_ [*operator()]]]
- [Perform certificate verification. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__rfc2818_verification.rfc2818_verification [*rfc2818_verification]]]
- [Constructor. ]
- ]
-
-]
+[indexterm2 connect..stream_socket_service]
+Connect the stream socket to the specified endpoint.
-[heading Example]
-
-The following example shows how to synchronously open a secure connection to a given host name:
+ boost::system::error_code connect(
+ implementation_type & impl,
+ const endpoint_type & peer_endpoint,
+ boost::system::error_code & ec);
- using boost::asio::ip::tcp;
- namespace ssl = boost::asio::ssl;
- typedef ssl::stream<tcp::socket> ssl_socket;
- // Create a context that uses the default paths for finding CA certificates.
- ssl::context ctx(ssl::context::sslv23);
- ctx.set_default_verify_paths();
- // Open a socket and connect it to the remote host.
- boost::asio::io_service io_service;
- ssl_socket sock(io_service, ctx);
- tcp::resolver resolver(io_service);
- tcp::resolver::query query("host.name", "https");
- boost::asio::connect(sock.lowest_layer(), resolver.resolve(query));
- sock.lowest_layer().set_option(tcp::no_delay(true));
+[endsect]
- // Perform SSL handshake and verify the remote host's certificate.
- sock.set_verify_mode(ssl::verify_peer);
- sock.set_verify_callback(ssl::rfc2818_verification("host.name"));
- sock.handshake(ssl_socket::client);
- // ... read and write as normal ...
+[section:construct stream_socket_service::construct]
+[indexterm2 construct..stream_socket_service]
+Construct a new stream socket implementation.
+ void construct(
+ implementation_type & impl);
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/rfc2818_verification.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio/ssl.hpp]
-[section:operator_lp__rp_ ssl::rfc2818_verification::operator()]
+[section:destroy stream_socket_service::destroy]
-[indexterm2 operator()..ssl::rfc2818_verification]
-Perform certificate verification.
+[indexterm2 destroy..stream_socket_service]
+Destroy a stream socket implementation.
- bool operator()(
- bool preverified,
- verify_context & ctx) const;
+ void destroy(
+ implementation_type & impl);
@@ -83162,307 +87246,141 @@
-[section:result_type ssl::rfc2818_verification::result_type]
+[section:endpoint_type stream_socket_service::endpoint_type]
-[indexterm2 result_type..ssl::rfc2818_verification]
-The type of the function object's result.
+[indexterm2 endpoint_type..stream_socket_service]
+The endpoint type.
- typedef bool result_type;
+ typedef Protocol::endpoint endpoint_type;
[heading Requirements]
-[*Header: ][^boost/asio/ssl/rfc2818_verification.hpp]
+[*Header: ][^boost/asio/stream_socket_service.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:rfc2818_verification ssl::rfc2818_verification::rfc2818_verification]
-
-[indexterm2 rfc2818_verification..ssl::rfc2818_verification]
-Constructor.
+[section:get_io_service stream_socket_service::get_io_service]
- rfc2818_verification(
- const std::string & host);
+['Inherited from io_service.]
+[indexterm2 get_io_service..stream_socket_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-[endsect]
+ boost::asio::io_service & get_io_service();
[endsect]
-[section:ssl__stream ssl::stream]
-
-
-Provides stream-oriented functionality using SSL.
-
-
- template<
- typename Stream>
- class stream :
- public ssl::stream_base,
- noncopyable
-
-
-[heading Types]
-[table
- [[Name][Description]]
-
- [
-
- [[link boost_asio.reference.ssl__stream__impl_struct [*impl_struct]]]
- [Structure for use with deprecated impl_type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ssl__stream.handshake_type [*handshake_type]]]
- [Different handshake types. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ssl__stream.impl_type [*impl_type]]]
- [(Deprecated: Use native_handle_type.) The underlying implementation type. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ssl__stream.lowest_layer_type [*lowest_layer_type]]]
- [The type of the lowest layer. ]
-
- ]
-
- [
-
- [[link boost_asio.reference.ssl__stream.native_handle_type [*native_handle_type]]]
- [The native handle type of the SSL stream. ]
-
- ]
- [
- [[link boost_asio.reference.ssl__stream.next_layer_type [*next_layer_type]]]
- [The type of the next layer. ]
-
- ]
+[section:get_option stream_socket_service::get_option]
-]
+[indexterm2 get_option..stream_socket_service]
+Get a socket option.
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.ssl__stream.async_handshake [*async_handshake]]]
- [Start an asynchronous SSL handshake. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.async_read_some [*async_read_some]]]
- [Start an asynchronous read. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.async_shutdown [*async_shutdown]]]
- [Asynchronously shut down SSL on the stream. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.async_write_some [*async_write_some]]]
- [Start an asynchronous write. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.get_io_service [*get_io_service]]]
- [Get the io_service associated with the object. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.handshake [*handshake]]]
- [Perform SSL handshaking. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.impl [*impl]]]
- [(Deprecated: Use native_handle().) Get the underlying implementation in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.lowest_layer [*lowest_layer]]]
- [Get a reference to the lowest layer. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.native_handle [*native_handle]]]
- [Get the underlying implementation in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.next_layer [*next_layer]]]
- [Get a reference to the next layer. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.read_some [*read_some]]]
- [Read some data from the stream. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.set_verify_callback [*set_verify_callback]]]
- [Set the callback used to verify peer certificates. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.set_verify_mode [*set_verify_mode]]]
- [Set the peer verification mode. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.shutdown [*shutdown]]]
- [Shut down SSL on the stream. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.stream [*stream]]]
- [Construct a stream. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream.write_some [*write_some]]]
- [Write some data to the stream. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__stream._stream [*~stream]]]
- [Destructor. ]
- ]
-
-]
+ template<
+ typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
+ boost::system::error_code get_option(
+ const implementation_type & impl,
+ GettableSocketOption & option,
+ boost::system::error_code & ec) const;
-The stream class template provides asynchronous and blocking stream-oriented functionality using SSL.
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
+[endsect]
-[*Shared] [*objects:] Unsafe. The application must also ensure that all asynchronous operations are performed within the same implicit or explicit strand.
-[heading Example]
-
-To use the SSL stream template with an `ip::tcp::socket`, you would write:
+[section:id stream_socket_service::id]
- boost::asio::io_service io_service;
- boost::asio::ssl::context ctx(boost::asio::ssl::context::sslv23);
- boost::asio::ssl::stream<asio:ip::tcp::socket> sock(io_service, ctx);
+[indexterm2 id..stream_socket_service]
+The unique service identifier.
+ static boost::asio::io_service::id id;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/stream.hpp]
+[section:implementation_type stream_socket_service::implementation_type]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[indexterm2 implementation_type..stream_socket_service]
+The type of a stream socket implementation.
-[section:async_handshake ssl::stream::async_handshake]
+ typedef implementation_defined implementation_type;
-[indexterm2 async_handshake..ssl::stream]
-Start an asynchronous SSL handshake.
- template<
- typename ``[link boost_asio.reference.HandshakeHandler HandshakeHandler]``>
- void async_handshake(
- handshake_type type,
- HandshakeHandler handler);
+[heading Requirements]
+[*Header: ][^boost/asio/stream_socket_service.hpp]
-This function is used to asynchronously perform an SSL handshake on the stream. This function call always returns immediately.
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
-[[handler][The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error // Result of operation.
- );
-``
-]]
-]
+[section:io_control stream_socket_service::io_control]
+[indexterm2 io_control..stream_socket_service]
+Perform an IO control command on the socket.
+ template<
+ typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
+ boost::system::error_code io_control(
+ implementation_type & impl,
+ IoControlCommand & command,
+ boost::system::error_code & ec);
-[endsect]
+[endsect]
-[section:async_read_some ssl::stream::async_read_some]
-[indexterm2 async_read_some..ssl::stream]
-Start an asynchronous read.
+[section:is_open stream_socket_service::is_open]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_read_some(
- const MutableBufferSequence & buffers,
- ReadHandler handler);
+[indexterm2 is_open..stream_socket_service]
+Determine whether the socket is open.
-This function is used to asynchronously read one or more bytes of data from the stream. The function call always returns immediately.
+ bool is_open(
+ const implementation_type & impl) const;
-[heading Parameters]
-
-[variablelist
-
-[[buffers][The buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
+[endsect]
-[[handler][The handler to be called when the read operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- std::size_t bytes_transferred // Number of bytes read.
- );
-``
-]]
-]
+[section:local_endpoint stream_socket_service::local_endpoint]
+
+[indexterm2 local_endpoint..stream_socket_service]
+Get the local endpoint.
-[heading Remarks]
-
-The async\_read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.async_read `async_read`] function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.
+ endpoint_type local_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
@@ -83470,963 +87388,1129 @@
-[section:async_shutdown ssl::stream::async_shutdown]
+[section:move_assign stream_socket_service::move_assign]
-[indexterm2 async_shutdown..ssl::stream]
-Asynchronously shut down SSL on the stream.
+[indexterm2 move_assign..stream_socket_service]
+Move-assign from another stream socket implementation.
- template<
- typename ``[link boost_asio.reference.ShutdownHandler ShutdownHandler]``>
- void async_shutdown(
- ShutdownHandler handler);
+ void move_assign(
+ implementation_type & impl,
+ stream_socket_service & other_service,
+ implementation_type & other_impl);
-This function is used to asynchronously shut down SSL on the stream. This function call always returns immediately.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[handler][The handler to be called when the handshake operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error // Result of operation.
- );
-``
-]]
-]
+[section:move_construct stream_socket_service::move_construct]
+[indexterm2 move_construct..stream_socket_service]
+Move-construct a new stream socket implementation.
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
-[endsect]
+[endsect]
-[section:async_write_some ssl::stream::async_write_some]
-[indexterm2 async_write_some..ssl::stream]
-Start an asynchronous write.
+[section:native stream_socket_service::native]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_write_some(
- const ConstBufferSequence & buffers,
- WriteHandler handler);
+[indexterm2 native..stream_socket_service]
+(Deprecated: Use `native_handle()`.) Get the native socket implementation.
-This function is used to asynchronously write one or more bytes of data to the stream. The function call always returns immediately.
+ native_type native(
+ implementation_type & impl);
-[heading Parameters]
-
-[variablelist
-
-[[buffers][The data to be written to the stream. Although the buffers object may be copied as necessary, ownership of the underlying buffers is retained by the caller, which must guarantee that they remain valid until the handler is called.]]
+[endsect]
-[[handler][The handler to be called when the write operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:
-``
- void handler(
- const boost::system::error_code& error, // Result of operation.
- std::size_t bytes_transferred // Number of bytes written.
- );
-``
-]]
-]
+[section:native_handle stream_socket_service::native_handle]
-[heading Remarks]
-
-The async\_write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.async_write `async_write`] function if you need to ensure that all data is written before the blocking operation completes.
+[indexterm2 native_handle..stream_socket_service]
+Get the native socket implementation.
+ native_handle_type native_handle(
+ implementation_type & impl);
-[endsect]
+[endsect]
-[section:get_io_service ssl::stream::get_io_service]
-[indexterm2 get_io_service..ssl::stream]
-Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+[section:native_handle_type stream_socket_service::native_handle_type]
+[indexterm2 native_handle_type..stream_socket_service]
+The native socket type.
- boost::asio::io_service & get_io_service();
+ typedef implementation_defined native_handle_type;
-This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the stream uses to dispatch handlers for asynchronous operations.
-[heading Return Value]
-
-A reference to the [link boost_asio.reference.io_service `io_service`] object that stream will use to dispatch handlers. Ownership is not transferred to the caller.
+[heading Requirements]
+[*Header: ][^boost/asio/stream_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:handshake ssl::stream::handshake]
+[section:native_non_blocking stream_socket_service::native_non_blocking]
-[indexterm2 handshake..ssl::stream]
-Perform SSL handshaking.
+[indexterm2 native_non_blocking..stream_socket_service]
+Gets the non-blocking mode of the native socket implementation.
- void ``[link boost_asio.reference.ssl__stream.handshake.overload1 handshake]``(
- handshake_type type);
- `` [''''»''' [link boost_asio.reference.ssl__stream.handshake.overload1 more...]]``
+ bool ``[link boost_asio.reference.stream_socket_service.native_non_blocking.overload1 native_non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.stream_socket_service.native_non_blocking.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.ssl__stream.handshake.overload2 handshake]``(
- handshake_type type,
+
+Sets the non-blocking mode of the native socket implementation.
+
+
+ boost::system::error_code ``[link boost_asio.reference.stream_socket_service.native_non_blocking.overload2 native_non_blocking]``(
+ implementation_type & impl,
+ bool mode,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.handshake.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.stream_socket_service.native_non_blocking.overload2 more...]]``
-[section:overload1 ssl::stream::handshake (1 of 2 overloads)]
+[section:overload1 stream_socket_service::native_non_blocking (1 of 2 overloads)]
-Perform SSL handshaking.
+Gets the non-blocking mode of the native socket implementation.
- void handshake(
- handshake_type type);
+ bool native_non_blocking(
+ const implementation_type & impl) const;
-This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.
+[endsect]
-[heading Parameters]
-
-[variablelist
-
-[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
-]
+[section:overload2 stream_socket_service::native_non_blocking (2 of 2 overloads)]
-[heading Exceptions]
-
+Sets the non-blocking mode of the native socket implementation.
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
-]
+ boost::system::error_code native_non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+
+[endsect]
[endsect]
+[section:native_type stream_socket_service::native_type]
-[section:overload2 ssl::stream::handshake (2 of 2 overloads)]
+[indexterm2 native_type..stream_socket_service]
+(Deprecated: Use native\_handle\_type.) The native socket type.
-Perform SSL handshaking.
+ typedef implementation_defined native_type;
- boost::system::error_code handshake(
- handshake_type type,
- boost::system::error_code & ec);
+[heading Requirements]
-This function is used to perform SSL handshaking on the stream. The function call will block until handshaking is complete or an error occurs.
+[*Header: ][^boost/asio/stream_socket_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
-[variablelist
-
-[[type][The type of handshaking to be performed, i.e. as a client or as a server.]]
+[endsect]
-[[ec][Set to indicate what error occurred, if any. ]]
-]
+[section:non_blocking stream_socket_service::non_blocking]
+[indexterm2 non_blocking..stream_socket_service]
+Gets the non-blocking mode of the socket.
+ bool ``[link boost_asio.reference.stream_socket_service.non_blocking.overload1 non_blocking]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.stream_socket_service.non_blocking.overload1 more...]]``
-[endsect]
+Sets the non-blocking mode of the socket.
-[endsect]
+ boost::system::error_code ``[link boost_asio.reference.stream_socket_service.non_blocking.overload2 non_blocking]``(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.stream_socket_service.non_blocking.overload2 more...]]``
-[section:handshake_type ssl::stream::handshake_type]
-[indexterm2 handshake_type..ssl::stream]
-Different handshake types.
+[section:overload1 stream_socket_service::non_blocking (1 of 2 overloads)]
- enum handshake_type
+Gets the non-blocking mode of the socket.
-[indexterm2 client..ssl::stream]
-[indexterm2 server..ssl::stream]
-[heading Values]
-[variablelist
+ bool non_blocking(
+ const implementation_type & impl) const;
- [
- [client]
- [Perform handshaking as a client. ]
- ]
- [
- [server]
- [Perform handshaking as a server. ]
- ]
-]
+[endsect]
+
+
+
+[section:overload2 stream_socket_service::non_blocking (2 of 2 overloads)]
+
+
+Sets the non-blocking mode of the socket.
+
+
+ boost::system::error_code non_blocking(
+ implementation_type & impl,
+ bool mode,
+ boost::system::error_code & ec);
[endsect]
+[endsect]
-[section:impl ssl::stream::impl]
-[indexterm2 impl..ssl::stream]
-(Deprecated: Use `native_handle()`.) Get the underlying implementation in the native type.
+[section:open stream_socket_service::open]
+[indexterm2 open..stream_socket_service]
+Open a stream socket.
- impl_type impl();
+ boost::system::error_code open(
+ implementation_type & impl,
+ const protocol_type & protocol,
+ boost::system::error_code & ec);
-This function may be used to obtain the underlying implementation of the context. This is intended to allow access to stream functionality that is not otherwise provided.
[endsect]
-[section:impl_type ssl::stream::impl_type]
+[section:protocol_type stream_socket_service::protocol_type]
-[indexterm2 impl_type..ssl::stream]
-(Deprecated: Use native\_handle\_type.) The underlying implementation type.
+[indexterm2 protocol_type..stream_socket_service]
+The protocol type.
- typedef impl_struct * impl_type;
+ typedef Protocol protocol_type;
[heading Requirements]
-[*Header: ][^boost/asio/ssl/stream.hpp]
+[*Header: ][^boost/asio/stream_socket_service.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:lowest_layer ssl::stream::lowest_layer]
-[indexterm2 lowest_layer..ssl::stream]
-Get a reference to the lowest layer.
+[section:receive stream_socket_service::receive]
+[indexterm2 receive..stream_socket_service]
+Receive some data from the peer.
- lowest_layer_type & ``[link boost_asio.reference.ssl__stream.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.ssl__stream.lowest_layer.overload1 more...]]``
- const lowest_layer_type & ``[link boost_asio.reference.ssl__stream.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.ssl__stream.lowest_layer.overload2 more...]]``
+ template<
+ typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
+ std::size_t receive(
+ implementation_type & impl,
+ const MutableBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-[section:overload1 ssl::stream::lowest_layer (1 of 2 overloads)]
+[endsect]
-Get a reference to the lowest layer.
- lowest_layer_type & lowest_layer();
+[section:remote_endpoint stream_socket_service::remote_endpoint]
+
+[indexterm2 remote_endpoint..stream_socket_service]
+Get the remote endpoint.
-This function returns a reference to the lowest layer in a stack of stream layers.
+ endpoint_type remote_endpoint(
+ const implementation_type & impl,
+ boost::system::error_code & ec) const;
-[heading Return Value]
-
-A reference to the lowest layer in the stack of stream layers. Ownership is not transferred to the caller.
+[endsect]
-[endsect]
+[section:send stream_socket_service::send]
+[indexterm2 send..stream_socket_service]
+Send the given data to the peer.
-[section:overload2 ssl::stream::lowest_layer (2 of 2 overloads)]
+ template<
+ typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
+ std::size_t send(
+ implementation_type & impl,
+ const ConstBufferSequence & buffers,
+ socket_base::message_flags flags,
+ boost::system::error_code & ec);
-Get a reference to the lowest layer.
+[endsect]
- const lowest_layer_type & lowest_layer() const;
-This function returns a reference to the lowest layer in a stack of stream layers.
+[section:set_option stream_socket_service::set_option]
+[indexterm2 set_option..stream_socket_service]
+Set a socket option.
-[heading Return Value]
-
-A reference to the lowest layer in the stack of stream layers. Ownership is not transferred to the caller.
+ template<
+ typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
+ boost::system::error_code set_option(
+ implementation_type & impl,
+ const SettableSocketOption & option,
+ boost::system::error_code & ec);
[endsect]
-[endsect]
+[section:shutdown stream_socket_service::shutdown]
-[section:lowest_layer_type ssl::stream::lowest_layer_type]
+[indexterm2 shutdown..stream_socket_service]
+Disable sends or receives on the socket.
-[indexterm2 lowest_layer_type..ssl::stream]
-The type of the lowest layer.
+ boost::system::error_code shutdown(
+ implementation_type & impl,
+ socket_base::shutdown_type what,
+ boost::system::error_code & ec);
- typedef next_layer_type::lowest_layer_type lowest_layer_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/stream.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:stream_socket_service stream_socket_service::stream_socket_service]
+
+[indexterm2 stream_socket_service..stream_socket_service]
+Construct a new stream socket service for the specified [link boost_asio.reference.io_service `io_service`].
+
+
+ stream_socket_service(
+ boost::asio::io_service & io_service);
+
[endsect]
-[section:native_handle ssl::stream::native_handle]
+[endsect]
-[indexterm2 native_handle..ssl::stream]
-Get the underlying implementation in the native type.
+[section:streambuf streambuf]
- native_handle_type native_handle();
+[indexterm1 streambuf]
+Typedef for the typical usage of [link boost_asio.reference.basic_streambuf `basic_streambuf`].
-This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
+ typedef basic_streambuf streambuf;
-[heading Example]
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.basic_streambuf.const_buffers_type [*const_buffers_type]]]
+ [The type used to represent the input sequence as a list of buffers. ]
-The `native_handle()` function returns a pointer of type `SSL*` that is suitable for passing to functions such as `SSL_get_verify_result` and `SSL_get_peer_certificate:`
+ ]
- boost::asio::ssl::stream<asio:ip::tcp::socket> sock(io_service, ctx);
+ [
- // ... establish connection and perform handshake ...
+ [[link boost_asio.reference.basic_streambuf.mutable_buffers_type [*mutable_buffers_type]]]
+ [The type used to represent the output sequence as a list of buffers. ]
+
+ ]
- if (X509* cert = SSL_get_peer_certificate(sock.native_handle()))
- {
- if (SSL_get_verify_result(sock.native_handle()) == X509_V_OK)
- {
- // ...
- }
- }
+]
+[heading Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_streambuf.basic_streambuf [*basic_streambuf]]]
+ [Construct a basic_streambuf object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.commit [*commit]]]
+ [Move characters from the output sequence to the input sequence. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.consume [*consume]]]
+ [Remove characters from the input sequence. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.data [*data]]]
+ [Get a list of buffers that represents the input sequence. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.max_size [*max_size]]]
+ [Get the maximum size of the basic_streambuf. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.prepare [*prepare]]]
+ [Get a list of buffers that represents the output sequence, with the given size. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.size [*size]]]
+ [Get the size of the input sequence. ]
+ ]
+
+]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_streambuf.overflow [*overflow]]]
+ [Override std::streambuf behaviour. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.reserve [*reserve]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.basic_streambuf.underflow [*underflow]]]
+ [Override std::streambuf behaviour. ]
+ ]
+
+]
+The `basic_streambuf` class is derived from `std::streambuf` to associate the streambuf's input and output sequences with one or more character arrays. These character arrays are internal to the `basic_streambuf` object, but direct access to the array elements is provided to permit them to be used efficiently with I/O operations. Characters written to the output sequence of a `basic_streambuf` object are appended to the input sequence of the same object.
+The `basic_streambuf` class's public interface is intended to permit the following implementation strategies:
-[endsect]
+* A single contiguous character array, which is reallocated as necessary to accommodate changes in the size of the character sequence. This is the implementation approach currently used in Asio.
-[section:native_handle_type ssl::stream::native_handle_type]
+* A sequence of one or more character arrays, where each array is of the same size. Additional character array objects are appended to the sequence to accommodate changes in the size of the character sequence.
-[indexterm2 native_handle_type..ssl::stream]
-The native handle type of the SSL stream.
+* A sequence of one or more character arrays of varying sizes. Additional character array objects are appended to the sequence to accommodate changes in the size of the character sequence.
- typedef SSL * native_handle_type;
+The constructor for [link boost_asio.reference.basic_streambuf `basic_streambuf`] accepts a `size_t` argument specifying the maximum of the sum of the sizes of the input sequence and output sequence. During the lifetime of the `basic_streambuf` object, the following invariant holds:
+ size() <= max_size()
-[heading Requirements]
+Any member function that would, if successful, cause the invariant to be violated shall throw an exception of class `std::length_error`.
-[*Header: ][^boost/asio/ssl/stream.hpp]
+The constructor for `basic_streambuf` takes an Allocator argument. A copy of this argument is used for any memory allocation performed, by the constructor and by all member functions, during the lifetime of each `basic_streambuf` object.
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[heading Examples]
+
+Writing directly from an streambuf to a socket:
-[endsect]
+ boost::asio::streambuf b;
+ std::ostream os(&b);
+ os << "Hello, World!\n";
+ // try sending some data in input sequence
+ size_t n = sock.send(b.data());
-[section:next_layer ssl::stream::next_layer]
+ b.consume(n); // sent data is removed from input sequence
-[indexterm2 next_layer..ssl::stream]
-Get a reference to the next layer.
- const next_layer_type & ``[link boost_asio.reference.ssl__stream.next_layer.overload1 next_layer]``() const;
- `` [''''»''' [link boost_asio.reference.ssl__stream.next_layer.overload1 more...]]``
- next_layer_type & ``[link boost_asio.reference.ssl__stream.next_layer.overload2 next_layer]``();
- `` [''''»''' [link boost_asio.reference.ssl__stream.next_layer.overload2 more...]]``
+Reading from a socket directly into a streambuf:
+ boost::asio::streambuf b;
-[section:overload1 ssl::stream::next_layer (1 of 2 overloads)]
+ // reserve 512 bytes in output sequence
+ boost::asio::streambuf::mutable_buffers_type bufs = b.prepare(512);
+ size_t n = sock.receive(bufs);
-Get a reference to the next layer.
+ // received data is "committed" from output sequence to input sequence
+ b.commit(n);
+ std::istream is(&b);
+ std::string s;
+ is >> s;
- const next_layer_type & next_layer() const;
-This function returns a reference to the next layer in a stack of stream layers.
-[heading Return Value]
-
-A reference to the next layer in the stack of stream layers. Ownership is not transferred to the caller.
+[heading Requirements]
+[*Header: ][^boost/asio/streambuf.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:overload2 ssl::stream::next_layer (2 of 2 overloads)]
-
-
-Get a reference to the next layer.
-
+[section:system_timer system_timer]
- next_layer_type & next_layer();
+[indexterm1 system_timer]
+Typedef for a timer based on the system clock.
-This function returns a reference to the next layer in a stack of stream layers.
+ typedef basic_waitable_timer< chrono::system_clock > system_timer;
-[heading Return Value]
-
-A reference to the next layer in the stack of stream layers. Ownership is not transferred to the caller.
+[heading Types]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.clock_type [*clock_type]]]
+ [The clock type. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_waitable_timer.duration [*duration]]]
+ [The duration type of the clock. ]
+
+ ]
+ [
-[endsect]
+ [[link boost_asio.reference.basic_waitable_timer.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+ [
-[section:next_layer_type ssl::stream::next_layer_type]
+ [[link boost_asio.reference.basic_waitable_timer.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
-[indexterm2 next_layer_type..ssl::stream]
-The type of the next layer.
+ [
+ [[link boost_asio.reference.basic_waitable_timer.time_point [*time_point]]]
+ [The time point type of the clock. ]
+
+ ]
- typedef boost::remove_reference< Stream >::type next_layer_type;
+ [
+ [[link boost_asio.reference.basic_waitable_timer.traits_type [*traits_type]]]
+ [The wait traits type. ]
+
+ ]
+]
-[heading Requirements]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[*Header: ][^boost/asio/ssl/stream.hpp]
+ [
+ [[link boost_asio.reference.basic_waitable_timer.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.basic_waitable_timer [*basic_waitable_timer]]]
+ [Constructor.
-[*Convenience header: ][^boost/asio/ssl.hpp]
+ Constructor to set a particular expiry time as an absolute time.
+ Constructor to set a particular expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel [*cancel]]]
+ [Cancel any asynchronous operations that are waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous operation that is waiting on the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_at [*expires_at]]]
+ [Get the timer's expiry time as an absolute time.
-[endsect]
+ Set the timer's expiry time as an absolute time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.expires_from_now [*expires_from_now]]]
+ [Get the timer's expiry time relative to now.
+ Set the timer's expiry time relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.wait [*wait]]]
+ [Perform a blocking wait on the timer. ]
+ ]
+
+]
-[section:read_some ssl::stream::read_some]
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
-[indexterm2 read_some..ssl::stream]
-Read some data from the stream.
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.basic_waitable_timer.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.ssl__stream.read_some.overload1 read_some]``(
- const MutableBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.ssl__stream.read_some.overload1 more...]]``
+ [
+ [[link boost_asio.reference.basic_waitable_timer.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t ``[link boost_asio.reference.ssl__stream.read_some.overload2 read_some]``(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.read_some.overload2 more...]]``
+ [
+ [[link boost_asio.reference.basic_waitable_timer.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
-[section:overload1 ssl::stream::read_some (1 of 2 overloads)]
+The [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] class template provides the ability to perform a blocking or asynchronous wait for a timer to expire.
+A waitable timer is always in one of two states: "expired" or "not expired". If the `wait()` or `async_wait()` function is called on an expired timer, the wait operation will complete immediately.
-Read some data from the stream.
+Most applications will use the boost::asio::waitable\_timer typedef.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers);
+[heading Remarks]
+
+This waitable timer functionality is for use with the C++11 standard library's `<chrono>` facility, or with the Boost.Chrono library.
-This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-[heading Parameters]
-
-[variablelist
+[heading Examples]
-[[buffers][The buffers into which the data will be read.]]
+Performing a blocking wait:
-]
+ // Construct a timer without setting an expiry time.
+ boost::asio::waitable_timer timer(io_service);
+ // Set an expiry time relative to now.
+ timer.expires_from_now(boost::posix_time::seconds(5));
-[heading Return Value]
-
-The number of bytes read.
+ // Wait for the timer to expire.
+ timer.wait();
-[heading Exceptions]
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
-]
+Performing an asynchronous wait:
-[heading Remarks]
-
-The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+ void handler(const boost::system::error_code& error)
+ {
+ if (!error)
+ {
+ // Timer expired.
+ }
+ }
+ ...
+ // Construct a timer with an absolute expiry time.
+ boost::asio::waitable_timer timer(io_service,
+ boost::posix_time::time_from_string("2005-12-07 23:59:59.000"));
+ // Start an asynchronous wait.
+ timer.async_wait(handler);
-[endsect]
-[section:overload2 ssl::stream::read_some (2 of 2 overloads)]
+[heading Changing an active waitable_timer's expiry time]
+
-Read some data from the stream.
+Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled. To ensure that the action associated with the timer is performed only once, use something like this: used:
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t read_some(
- const MutableBufferSequence & buffers,
- boost::system::error_code & ec);
-This function is used to read data from the stream. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.
+ void on_some_event()
+ {
+ if (my_timer.expires_from_now(seconds(5)) > 0)
+ {
+ // We managed to cancel the timer. Start new asynchronous wait.
+ my_timer.async_wait(on_timeout);
+ }
+ else
+ {
+ // Too late, timer has already expired!
+ }
+ }
+ void on_timeout(const boost::system::error_code& e)
+ {
+ if (e != boost::asio::error::operation_aborted)
+ {
+ // Timer was not cancelled, take necessary action.
+ }
+ }
-[heading Parameters]
-
-[variablelist
-
-[[buffers][The buffers into which the data will be read.]]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+* The `boost::asio::basic_waitable_timer::expires_from_now()` function cancels any pending asynchronous waits, and returns the number of asynchronous waits that were cancelled. If it returns 0 then you were too late and the wait handler has already been executed, or will soon be executed. If it returns 1 then the wait handler was successfully cancelled.
-[heading Return Value]
-
-The number of bytes read. Returns 0 if an error occurred.
+* If a wait handler is cancelled, the boost::system::error\_code passed to it contains the value `boost::asio::error::operation_aborted`.
-[heading Remarks]
-
-The read\_some operation may not read all of the requested number of bytes. Consider using the [link boost_asio.reference.read `read`] function if you need to ensure that the requested amount of data is read before the blocking operation completes.
+This typedef uses the C++11 `<chrono>` standard library facility, if available. Otherwise, it may use the Boost.Chrono library. To explicitly utilise Boost.Chrono, use the [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] template directly:
-[endsect]
+ typedef basic_waitable_timer<boost::chrono::system_clock> timer;
-[endsect]
-[section:set_verify_callback ssl::stream::set_verify_callback]
-[indexterm2 set_verify_callback..ssl::stream]
-Set the callback used to verify peer certificates.
+[heading Requirements]
+[*Header: ][^boost/asio/system_timer.hpp]
- template<
- typename VerifyCallback>
- void ``[link boost_asio.reference.ssl__stream.set_verify_callback.overload1 set_verify_callback]``(
- VerifyCallback callback);
- `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_callback.overload1 more...]]``
+[*Convenience header: ]None
- template<
- typename VerifyCallback>
- boost::system::error_code ``[link boost_asio.reference.ssl__stream.set_verify_callback.overload2 set_verify_callback]``(
- VerifyCallback callback,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_callback.overload2 more...]]``
+[endsect]
-[section:overload1 ssl::stream::set_verify_callback (1 of 2 overloads)]
+[section:time_traits_lt__ptime__gt_ time_traits< boost::posix_time::ptime >]
-Set the callback used to verify peer certificates.
+Time traits specialised for posix\_time.
- template<
- typename VerifyCallback>
- void set_verify_callback(
- VerifyCallback callback);
+ template<>
+ struct time_traits< boost::posix_time::ptime >
-This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
+[heading Types]
+[table
+ [[Name][Description]]
-[heading Parameters]
-
+ [
-[variablelist
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.duration_type [*duration_type]]]
+ [The duration type. ]
-[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
-``
- bool verify_callback(
- bool preverified, // True if the certificate passed pre-verification.
- verify_context& ctx // The peer certificate and other context.
- );
-``
-The return value of the callback is true if the certificate has passed verification, false otherwise.]]
-
-]
-
+ ]
-[heading Exceptions]
-
+ [
-[variablelist
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.time_type [*time_type]]]
+ [The time type. ]
-[[boost::system::system_error][Thrown on failure.]]
+ ]
]
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[heading Remarks]
-
-Calls `SSL_set_verify`.
+ [
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.add [*add]]]
+ [Add a duration to a time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.less_than [*less_than]]]
+ [Test whether one time is less than another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.now [*now]]]
+ [Get the current time. ]
+ ]
+
+ [
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.subtract [*subtract]]]
+ [Subtract one time from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.time_traits_lt__ptime__gt_.to_posix_duration [*to_posix_duration]]]
+ [Convert to POSIX duration type. ]
+ ]
+
+]
+[heading Requirements]
+[*Header: ][^boost/asio/time_traits.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:add time_traits< boost::posix_time::ptime >::add]
+[indexterm2 add..time_traits< boost::posix_time::ptime >]
+Add a duration to a time.
-[section:overload2 ssl::stream::set_verify_callback (2 of 2 overloads)]
+ static time_type add(
+ const time_type & t,
+ const duration_type & d);
-Set the callback used to verify peer certificates.
- template<
- typename VerifyCallback>
- boost::system::error_code set_verify_callback(
- VerifyCallback callback,
- boost::system::error_code & ec);
+[endsect]
-This function is used to specify a callback function that will be called by the implementation when it needs to verify a peer certificate.
+[section:duration_type time_traits< boost::posix_time::ptime >::duration_type]
-[heading Parameters]
-
+[indexterm2 duration_type..time_traits< boost::posix_time::ptime >]
+The duration type.
-[variablelist
-
-[[callback][The function object to be used for verifying a certificate. The function signature of the handler must be:
-``
- bool verify_callback(
- bool preverified, // True if the certificate passed pre-verification.
- verify_context& ctx // The peer certificate and other context.
- );
-``
-The return value of the callback is true if the certificate has passed verification, false otherwise.]]
-[[ec][Set to indicate what error occurred, if any.]]
+ typedef boost::posix_time::time_duration duration_type;
-]
-[heading Remarks]
-
-Calls `SSL_set_verify`.
+[heading Requirements]
+[*Header: ][^boost/asio/time_traits.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[endsect]
-[section:set_verify_mode ssl::stream::set_verify_mode]
+[section:less_than time_traits< boost::posix_time::ptime >::less_than]
-[indexterm2 set_verify_mode..ssl::stream]
-Set the peer verification mode.
+[indexterm2 less_than..time_traits< boost::posix_time::ptime >]
+Test whether one time is less than another.
- void ``[link boost_asio.reference.ssl__stream.set_verify_mode.overload1 set_verify_mode]``(
- verify_mode v);
- `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_mode.overload1 more...]]``
+ static bool less_than(
+ const time_type & t1,
+ const time_type & t2);
- boost::system::error_code ``[link boost_asio.reference.ssl__stream.set_verify_mode.overload2 set_verify_mode]``(
- verify_mode v,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.set_verify_mode.overload2 more...]]``
-[section:overload1 ssl::stream::set_verify_mode (1 of 2 overloads)]
+[endsect]
-Set the peer verification mode.
+[section:now time_traits< boost::posix_time::ptime >::now]
- void set_verify_mode(
- verify_mode v);
+[indexterm2 now..time_traits< boost::posix_time::ptime >]
+Get the current time.
-This function may be used to configure the peer verification mode used by the stream. The new mode will override the mode inherited from the context.
+ static time_type now();
-[heading Parameters]
-
-[variablelist
-
-[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
+[endsect]
-]
-[heading Exceptions]
-
+[section:subtract time_traits< boost::posix_time::ptime >::subtract]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+[indexterm2 subtract..time_traits< boost::posix_time::ptime >]
+Subtract one time from another.
-]
+ static duration_type subtract(
+ const time_type & t1,
+ const time_type & t2);
-[heading Remarks]
-
-Calls `SSL_set_verify`.
+[endsect]
-[endsect]
+[section:time_type time_traits< boost::posix_time::ptime >::time_type]
+[indexterm2 time_type..time_traits< boost::posix_time::ptime >]
+The time type.
-[section:overload2 ssl::stream::set_verify_mode (2 of 2 overloads)]
+ typedef boost::posix_time::ptime time_type;
-Set the peer verification mode.
- boost::system::error_code set_verify_mode(
- verify_mode v,
- boost::system::error_code & ec);
+[heading Requirements]
+[*Header: ][^boost/asio/time_traits.hpp]
-This function may be used to configure the peer verification mode used by the stream. The new mode will override the mode inherited from the context.
+[*Convenience header: ][^boost/asio.hpp]
-[heading Parameters]
-
+[endsect]
-[variablelist
-
-[[v][A bitmask of peer verification modes. See [link boost_asio.reference.ssl__verify_mode `ssl::verify_mode`] for available values.]]
-[[ec][Set to indicate what error occurred, if any.]]
-]
+[section:to_posix_duration time_traits< boost::posix_time::ptime >::to_posix_duration]
+[indexterm2 to_posix_duration..time_traits< boost::posix_time::ptime >]
+Convert to POSIX duration type.
-[heading Remarks]
-
-Calls `SSL_set_verify`.
+ static boost::posix_time::time_duration to_posix_duration(
+ const duration_type & d);
[endsect]
+
[endsect]
-[section:shutdown ssl::stream::shutdown]
-[indexterm2 shutdown..ssl::stream]
-Shut down SSL on the stream.
+[section:transfer_all transfer_all]
+
+[indexterm1 transfer_all]
+Return a completion condition function object that indicates that a read or write operation should continue until all of the data has been transferred, or until an error occurs.
- void ``[link boost_asio.reference.ssl__stream.shutdown.overload1 shutdown]``();
- `` [''''»''' [link boost_asio.reference.ssl__stream.shutdown.overload1 more...]]``
+ unspecified transfer_all();
- boost::system::error_code ``[link boost_asio.reference.ssl__stream.shutdown.overload2 shutdown]``(
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.shutdown.overload2 more...]]``
+This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
-[section:overload1 ssl::stream::shutdown (1 of 2 overloads)]
+[heading Example]
+
+Reading until a buffer is full:
-Shut down SSL on the stream.
+ boost::array<char, 128> buf;
+ boost::system::error_code ec;
+ std::size_t n = boost::asio::read(
+ sock, boost::asio::buffer(buf),
+ boost::asio::transfer_all(), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ // n == 128
+ }
- void shutdown();
-This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.
-[heading Exceptions]
-
+[heading Requirements]
-[variablelist
-
-[[boost::system::system_error][Thrown on failure. ]]
+[*Header: ][^boost/asio/completion_condition.hpp]
-]
+[*Convenience header: ][^boost/asio.hpp]
+[endsect]
-[endsect]
+[section:transfer_at_least transfer_at_least]
+[indexterm1 transfer_at_least]
+Return a completion condition function object that indicates that a read or write operation should continue until a minimum number of bytes has been transferred, or until an error occurs.
-[section:overload2 ssl::stream::shutdown (2 of 2 overloads)]
+ unspecified transfer_at_least(
+ std::size_t minimum);
-Shut down SSL on the stream.
+This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
- boost::system::error_code shutdown(
- boost::system::error_code & ec);
+[heading Example]
+
+Reading until a buffer is full or contains at least 64 bytes:
-This function is used to shut down SSL on the stream. The function call will block until SSL has been shut down or an error occurs.
+ boost::array<char, 128> buf;
+ boost::system::error_code ec;
+ std::size_t n = boost::asio::read(
+ sock, boost::asio::buffer(buf),
+ boost::asio::transfer_at_least(64), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ // n >= 64 && n <= 128
+ }
-[heading Parameters]
-
-[variablelist
-
-[[ec][Set to indicate what error occurred, if any. ]]
-]
+[heading Requirements]
+[*Header: ][^boost/asio/completion_condition.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:stream ssl::stream::stream]
-[indexterm2 stream..ssl::stream]
-Construct a stream.
+[section:transfer_exactly transfer_exactly]
+[indexterm1 transfer_exactly]
+Return a completion condition function object that indicates that a read or write operation should continue until an exact number of bytes has been transferred, or until an error occurs.
- template<
- typename Arg>
- stream(
- Arg & arg,
- context & ctx);
+ unspecified transfer_exactly(
+ std::size_t size);
-This constructor creates a stream and initialises the underlying stream object.
+This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
-[heading Parameters]
-
-[variablelist
+[heading Example]
-[[arg][The argument to be passed to initialise the underlying stream.]]
-
-[[ctx][The SSL context to be used for the stream. ]]
-
-]
+Reading until a buffer is full or contains exactly 64 bytes:
+ boost::array<char, 128> buf;
+ boost::system::error_code ec;
+ std::size_t n = boost::asio::read(
+ sock, boost::asio::buffer(buf),
+ boost::asio::transfer_exactly(64), ec);
+ if (ec)
+ {
+ // An error occurred.
+ }
+ else
+ {
+ // n == 64
+ }
-[endsect]
-[section:write_some ssl::stream::write_some]
-[indexterm2 write_some..ssl::stream]
-Write some data to the stream.
+[heading Requirements]
+[*Header: ][^boost/asio/completion_condition.hpp]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.ssl__stream.write_some.overload1 write_some]``(
- const ConstBufferSequence & buffers);
- `` [''''»''' [link boost_asio.reference.ssl__stream.write_some.overload1 more...]]``
+[*Convenience header: ][^boost/asio.hpp]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t ``[link boost_asio.reference.ssl__stream.write_some.overload2 write_some]``(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.ssl__stream.write_some.overload2 more...]]``
+[endsect]
-[section:overload1 ssl::stream::write_some (1 of 2 overloads)]
-Write some data to the stream.
+[section:use_service use_service]
+[indexterm1 use_service]
template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers);
+ typename ``[link boost_asio.reference.Service Service]``>
+ Service & use_service(
+ io_service & ios);
-This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.
+This function is used to locate a service object that corresponds to the given service type. If there is no existing implementation of the service, then the [link boost_asio.reference.io_service `io_service`] will create a new instance of the service.
[heading Parameters]
@@ -84434,90 +88518,71 @@
[variablelist
-[[buffers][The data to be written.]]
+[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
]
[heading Return Value]
-The number of bytes written.
-
-
-[heading Exceptions]
-
-
-[variablelist
-
-[[boost::system::system_error][Thrown on failure.]]
+The service interface implementing the specified service type. Ownership of the service interface is not transferred to the caller.
-]
-[heading Remarks]
-
-The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
+[heading Requirements]
+[*Header: ][^boost/asio/io_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:overload2 ssl::stream::write_some (2 of 2 overloads)]
+[section:wait_traits wait_traits]
-Write some data to the stream.
+Wait traits suitable for use with the [link boost_asio.reference.basic_waitable_timer `basic_waitable_timer`] class template.
template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t write_some(
- const ConstBufferSequence & buffers,
- boost::system::error_code & ec);
-
-
-This function is used to write data on the stream. The function call will block until one or more bytes of data has been written successfully, or until an error occurs.
+ typename Clock>
+ struct wait_traits
-[heading Parameters]
-
+[heading Member Functions]
+[table
+ [[Name][Description]]
-[variablelist
+ [
+ [[link boost_asio.reference.wait_traits.to_wait_duration [*to_wait_duration]]]
+ [Convert a clock duration into a duration used for waiting. ]
+ ]
-[[buffers][The data to be written to the stream.]]
-
-[[ec][Set to indicate what error occurred, if any.]]
-
]
+[heading Requirements]
-[heading Return Value]
-
-The number of bytes written. Returns 0 if an error occurred.
-
-
-[heading Remarks]
-
-The write\_some operation may not transmit all of the data to the peer. Consider using the [link boost_asio.reference.write `write`] function if you need to ensure that all data is written before the blocking operation completes.
-
+[*Header: ][^boost/asio/wait_traits.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[endsect]
+[section:to_wait_duration wait_traits::to_wait_duration]
+[indexterm2 to_wait_duration..wait_traits]
+Convert a clock duration into a duration used for waiting.
-[endsect]
+ static Clock::duration to_wait_duration(
+ const typename Clock::duration & d);
-[section:_stream ssl::stream::~stream]
-[indexterm2 ~stream..ssl::stream]
-Destructor.
+[heading Return Value]
+
+`d`.
- ~stream();
@@ -84527,479 +88592,501 @@
[endsect]
-[section:ssl__stream__impl_struct ssl::stream::impl_struct]
+[section:waitable_timer_service waitable_timer_service]
-Structure for use with deprecated impl\_type.
+Default service implementation for a timer.
- struct impl_struct
+ template<
+ typename Clock,
+ typename ``[link boost_asio.reference.WaitTraits WaitTraits]`` = boost::asio::wait_traits<Clock>>
+ class waitable_timer_service :
+ public io_service::service
-[heading Data Members]
+[heading Types]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ssl__stream__impl_struct.ssl [*ssl]]]
- []
- ]
-
-]
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/ssl/stream.hpp]
-
-[*Convenience header: ][^boost/asio/ssl.hpp]
+ [[link boost_asio.reference.waitable_timer_service.clock_type [*clock_type]]]
+ [The clock type. ]
+
+ ]
-[section:ssl ssl::stream::impl_struct::ssl]
-
-[indexterm2 ssl..ssl::stream::impl_struct]
-
- SSL * ssl;
-
-
-
-[endsect]
-
+ [
+ [[link boost_asio.reference.waitable_timer_service.duration [*duration]]]
+ [The duration type of the clock. ]
+
+ ]
-[endsect]
+ [
-[section:ssl__stream_base ssl::stream_base]
+ [[link boost_asio.reference.waitable_timer_service.implementation_type [*implementation_type]]]
+ [The implementation type of the waitable timer. ]
+
+ ]
+ [
-The [link boost_asio.reference.ssl__stream_base `ssl::stream_base`] class is used as a base for the [link boost_asio.reference.ssl__stream `ssl::stream`] class template so that we have a common place to define various enums.
+ [[link boost_asio.reference.waitable_timer_service.time_point [*time_point]]]
+ [The time point type of the clock. ]
+
+ ]
+ [
- class stream_base
+ [[link boost_asio.reference.waitable_timer_service.traits_type [*traits_type]]]
+ [The wait traits type. ]
+
+ ]
+]
-[heading Types]
+[heading Member Functions]
[table
[[Name][Description]]
[
-
- [[link boost_asio.reference.ssl__stream_base.handshake_type [*handshake_type]]]
- [Different handshake types. ]
+ [[link boost_asio.reference.waitable_timer_service.async_wait [*async_wait]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.cancel [*cancel]]]
+ [Cancel any asynchronous wait operations associated with the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.cancel_one [*cancel_one]]]
+ [Cancels one asynchronous wait operation associated with the timer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.construct [*construct]]]
+ [Construct a new timer implementation. ]
+ ]
+ [
+ [[link boost_asio.reference.waitable_timer_service.destroy [*destroy]]]
+ [Destroy a timer implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.expires_at [*expires_at]]]
+ [Get the expiry time for the timer as an absolute time.
+
+ Set the expiry time for the timer as an absolute time. ]
]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.expires_from_now [*expires_from_now]]]
+ [Get the expiry time for the timer relative to now.
+ Set the expiry time for the timer relative to now. ]
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.wait [*wait]]]
+ []
+ ]
+
+ [
+ [[link boost_asio.reference.waitable_timer_service.waitable_timer_service [*waitable_timer_service]]]
+ [Construct a new timer service for the specified io_service. ]
+ ]
+
]
-[heading Protected Member Functions]
+[heading Data Members]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.ssl__stream_base._stream_base [*~stream_base]]]
- [Protected destructor to prevent deletion through this type. ]
+ [[link boost_asio.reference.waitable_timer_service.id [*id]]]
+ [The unique service identifier. ]
]
-
+
]
[heading Requirements]
-[*Header: ][^boost/asio/ssl/stream_base.hpp]
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[section:handshake_type ssl::stream_base::handshake_type]
+[section:async_wait waitable_timer_service::async_wait]
-[indexterm2 handshake_type..ssl::stream_base]
-Different handshake types.
+[indexterm2 async_wait..waitable_timer_service]
+ template<
+ typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
+ void async_wait(
+ implementation_type & impl,
+ WaitHandler handler);
- enum handshake_type
-[indexterm2 client..ssl::stream_base]
-[indexterm2 server..ssl::stream_base]
-[heading Values]
-[variablelist
+[endsect]
- [
- [client]
- [Perform handshaking as a client. ]
- ]
- [
- [server]
- [Perform handshaking as a server. ]
- ]
-]
+[section:cancel waitable_timer_service::cancel]
+[indexterm2 cancel..waitable_timer_service]
+Cancel any asynchronous wait operations associated with the timer.
-[endsect]
+ std::size_t cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[section:_stream_base ssl::stream_base::~stream_base]
+[endsect]
-[indexterm2 ~stream_base..ssl::stream_base]
-Protected destructor to prevent deletion through this type.
- ~stream_base();
+[section:cancel_one waitable_timer_service::cancel_one]
+[indexterm2 cancel_one..waitable_timer_service]
+Cancels one asynchronous wait operation associated with the timer.
-[endsect]
+ std::size_t cancel_one(
+ implementation_type & impl,
+ boost::system::error_code & ec);
[endsect]
-[section:ssl__verify_client_once ssl::verify_client_once]
-[indexterm1 ssl::verify_client_once]
-Do not request client certificate on renegotiation. Ignored unless [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`] is set.
+[section:clock_type waitable_timer_service::clock_type]
+[indexterm2 clock_type..waitable_timer_service]
+The clock type.
+
+
+ typedef Clock clock_type;
- const int verify_client_once = implementation_defined;
[heading Requirements]
-[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:ssl__verify_context ssl::verify_context]
+[section:construct waitable_timer_service::construct]
-A simple wrapper around the X509\_STORE\_CTX type, used during verification of a peer certificate.
+[indexterm2 construct..waitable_timer_service]
+Construct a new timer implementation.
- class verify_context :
- noncopyable
+ void construct(
+ implementation_type & impl);
-[heading Types]
-[table
- [[Name][Description]]
- [
+[endsect]
- [[link boost_asio.reference.ssl__verify_context.native_handle_type [*native_handle_type]]]
- [The native handle type of the verification context. ]
-
- ]
-]
-[heading Member Functions]
-[table
- [[Name][Description]]
+[section:destroy waitable_timer_service::destroy]
- [
- [[link boost_asio.reference.ssl__verify_context.native_handle [*native_handle]]]
- [Get the underlying implementation in the native type. ]
- ]
-
- [
- [[link boost_asio.reference.ssl__verify_context.verify_context [*verify_context]]]
- [Constructor. ]
- ]
-
-]
+[indexterm2 destroy..waitable_timer_service]
+Destroy a timer implementation.
-[heading Remarks]
-
-The [link boost_asio.reference.ssl__verify_context `ssl::verify_context`] does not own the underlying X509\_STORE\_CTX object.
+ void destroy(
+ implementation_type & impl);
-[heading Requirements]
+[endsect]
-[*Header: ][^boost/asio/ssl/verify_context.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:duration waitable_timer_service::duration]
-[section:native_handle ssl::verify_context::native_handle]
+[indexterm2 duration..waitable_timer_service]
+The duration type of the clock.
-[indexterm2 native_handle..ssl::verify_context]
-Get the underlying implementation in the native type.
+ typedef clock_type::duration duration;
- native_handle_type native_handle();
-This function may be used to obtain the underlying implementation of the context. This is intended to allow access to context functionality that is not otherwise provided.
+[heading Requirements]
+
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
[endsect]
+[section:expires_at waitable_timer_service::expires_at]
-[section:native_handle_type ssl::verify_context::native_handle_type]
+[indexterm2 expires_at..waitable_timer_service]
+Get the expiry time for the timer as an absolute time.
-[indexterm2 native_handle_type..ssl::verify_context]
-The native handle type of the verification context.
+ time_point ``[link boost_asio.reference.waitable_timer_service.expires_at.overload1 expires_at]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.waitable_timer_service.expires_at.overload1 more...]]``
- typedef X509_STORE_CTX * native_handle_type;
+Set the expiry time for the timer as an absolute time.
-[heading Requirements]
+ std::size_t ``[link boost_asio.reference.waitable_timer_service.expires_at.overload2 expires_at]``(
+ implementation_type & impl,
+ const time_point & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.waitable_timer_service.expires_at.overload2 more...]]``
-[*Header: ][^boost/asio/ssl/verify_context.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+[section:overload1 waitable_timer_service::expires_at (1 of 2 overloads)]
-[endsect]
+Get the expiry time for the timer as an absolute time.
+ time_point expires_at(
+ const implementation_type & impl) const;
-[section:verify_context ssl::verify_context::verify_context]
-[indexterm2 verify_context..ssl::verify_context]
-Constructor.
+[endsect]
- verify_context(
- native_handle_type handle);
+[section:overload2 waitable_timer_service::expires_at (2 of 2 overloads)]
-[endsect]
+Set the expiry time for the timer as an absolute time.
-[endsect]
+ std::size_t expires_at(
+ implementation_type & impl,
+ const time_point & expiry_time,
+ boost::system::error_code & ec);
-[section:ssl__verify_fail_if_no_peer_cert ssl::verify_fail_if_no_peer_cert]
-[indexterm1 ssl::verify_fail_if_no_peer_cert]
-Fail verification if the peer has no certificate. Ignored unless [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`] is set.
+[endsect]
- const int verify_fail_if_no_peer_cert = implementation_defined;
+[endsect]
+[section:expires_from_now waitable_timer_service::expires_from_now]
-[heading Requirements]
+[indexterm2 expires_from_now..waitable_timer_service]
+Get the expiry time for the timer relative to now.
-[*Header: ][^boost/asio/ssl/verify_mode.hpp]
-[*Convenience header: ][^boost/asio/ssl.hpp]
+ duration ``[link boost_asio.reference.waitable_timer_service.expires_from_now.overload1 expires_from_now]``(
+ const implementation_type & impl) const;
+ `` [''''»''' [link boost_asio.reference.waitable_timer_service.expires_from_now.overload1 more...]]``
-[endsect]
+Set the expiry time for the timer relative to now.
+ std::size_t ``[link boost_asio.reference.waitable_timer_service.expires_from_now.overload2 expires_from_now]``(
+ implementation_type & impl,
+ const duration & expiry_time,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.waitable_timer_service.expires_from_now.overload2 more...]]``
-[section:ssl__verify_mode ssl::verify_mode]
-[indexterm1 ssl::verify_mode]
-Bitmask type for peer verification.
+[section:overload1 waitable_timer_service::expires_from_now (1 of 2 overloads)]
- typedef int verify_mode;
+Get the expiry time for the timer relative to now.
+ duration expires_from_now(
+ const implementation_type & impl) const;
-Possible values are:
-* [link boost_asio.reference.ssl__verify_none `ssl::verify_none`]
+[endsect]
-* [link boost_asio.reference.ssl__verify_peer `ssl::verify_peer`]
-* [link boost_asio.reference.ssl__verify_fail_if_no_peer_cert `ssl::verify_fail_if_no_peer_cert`]
-* [link boost_asio.reference.ssl__verify_client_once `ssl::verify_client_once`]
+[section:overload2 waitable_timer_service::expires_from_now (2 of 2 overloads)]
+Set the expiry time for the timer relative to now.
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+ std::size_t expires_from_now(
+ implementation_type & impl,
+ const duration & expiry_time,
+ boost::system::error_code & ec);
-[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
+[endsect]
-[section:ssl__verify_none ssl::verify_none]
-[indexterm1 ssl::verify_none]
-No verification.
+[section:get_io_service waitable_timer_service::get_io_service]
- const int verify_none = implementation_defined;
+['Inherited from io_service.]
+[indexterm2 get_io_service..waitable_timer_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+ boost::asio::io_service & get_io_service();
-[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
-[section:ssl__verify_peer ssl::verify_peer]
-
-[indexterm1 ssl::verify_peer]
-Verify the peer.
-
-
- const int verify_peer = implementation_defined;
+[section:id waitable_timer_service::id]
+[indexterm2 id..waitable_timer_service]
+The unique service identifier.
-[heading Requirements]
-[*Header: ][^boost/asio/ssl/verify_mode.hpp]
+ static boost::asio::io_service::id id;
-[*Convenience header: ][^boost/asio/ssl.hpp]
[endsect]
-[section:strand strand]
+[section:implementation_type waitable_timer_service::implementation_type]
-[indexterm1 strand]
-Typedef for backwards compatibility.
+[indexterm2 implementation_type..waitable_timer_service]
+The implementation type of the waitable timer.
- typedef boost::asio::io_service::strand strand;
+ typedef implementation_defined implementation_type;
-[heading Member Functions]
-[table
- [[Name][Description]]
- [
- [[link boost_asio.reference.io_service__strand.dispatch [*dispatch]]]
- [Request the strand to invoke the given handler. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__strand.get_io_service [*get_io_service]]]
- [Get the io_service associated with the strand. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__strand.post [*post]]]
- [Request the strand to invoke the given handler and return immediately. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__strand.strand [*strand]]]
- [Constructor. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__strand.wrap [*wrap]]]
- [Create a new handler that automatically dispatches the wrapped handler on the strand. ]
- ]
-
- [
- [[link boost_asio.reference.io_service__strand._strand [*~strand]]]
- [Destructor. ]
- ]
-
-]
+[heading Requirements]
-The [link boost_asio.reference.io_service__strand `io_service::strand`] class provides the ability to post and dispatch handlers with the guarantee that none of those handlers will execute concurrently.
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Order of handler invocation]
-
-Given:
+[endsect]
-* a strand object `s`
-* an object `a` meeting completion handler requirements
+[section:time_point waitable_timer_service::time_point]
+[indexterm2 time_point..waitable_timer_service]
+The time point type of the clock.
-* an object `a1` which is an arbitrary copy of `a` made by the implementation
+ typedef clock_type::time_point time_point;
-* an object `b` meeting completion handler requirements
-* an object `b1` which is an arbitrary copy of `b` made by the implementation
+[heading Requirements]
-if any of the following conditions are true:
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-* `s.post(a)` happens-before `s.post(b)`
+[endsect]
-* `s.post(a)` happens-before `s.dispatch(b)`, where the latter is performed outside the strand
-* `s.dispatch(a)` happens-before `s.post(b)`, where the former is performed outside the strand
+[section:traits_type waitable_timer_service::traits_type]
+[indexterm2 traits_type..waitable_timer_service]
+The wait traits type.
-* `s.dispatch(a)` happens-before `s.dispatch(b)`, where both are performed outside the strand
-then `asio_handler_invoke(a1, &a1)` happens-before `asio_handler_invoke(b1, &b1)`.
+ typedef WaitTraits traits_type;
-Note that in the following case:
- async_op_1(..., s.wrap(a));
- async_op_2(..., s.wrap(b));
+[heading Requirements]
-the completion of the first async operation will perform `s.dispatch(a)`, and the second will perform `s.dispatch(b)`, but the order in which those are performed is unspecified. That is, you cannot state whether one happens-before the other. Therefore none of the above conditions are met and no ordering guarantee is made.
+[*Header: ][^boost/asio/waitable_timer_service.hpp]
+[*Convenience header: ][^boost/asio.hpp]
-[heading Thread Safety]
-
-[*Distinct] [*objects:] Safe.
-[*Shared] [*objects:] Safe.
+[endsect]
+[section:wait waitable_timer_service::wait]
+[indexterm2 wait..waitable_timer_service]
-[heading Requirements]
+ void wait(
+ implementation_type & impl,
+ boost::system::error_code & ec);
-[*Header: ][^boost/asio/strand.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+
+[endsect]
+
+
+
+[section:waitable_timer_service waitable_timer_service::waitable_timer_service]
+
+[indexterm2 waitable_timer_service..waitable_timer_service]
+Construct a new timer service for the specified [link boost_asio.reference.io_service `io_service`].
+
+
+ waitable_timer_service(
+ boost::asio::io_service & io_service);
+
[endsect]
-[section:stream_socket_service stream_socket_service]
+[endsect]
-Default service implementation for a stream socket.
+[section:windows__basic_handle windows::basic_handle]
+
+
+Provides Windows handle functionality.
template<
- typename ``[link boost_asio.reference.Protocol Protocol]``>
- class stream_socket_service :
- public io_service::service
+ typename ``[link boost_asio.reference.HandleService HandleService]``>
+ class basic_handle :
+ public basic_io_object< HandleService >
[heading Types]
@@ -85008,36 +89095,36 @@
[
- [[link boost_asio.reference.stream_socket_service.endpoint_type [*endpoint_type]]]
- [The endpoint type. ]
+ [[link boost_asio.reference.windows__basic_handle.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.stream_socket_service.implementation_type [*implementation_type]]]
- [The type of a stream socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_handle is always the lowest layer. ]
]
[
- [[link boost_asio.reference.stream_socket_service.native_handle_type [*native_handle_type]]]
- [The native socket type. ]
+ [[link boost_asio.reference.windows__basic_handle.native_handle_type [*native_handle_type]]]
+ [The native representation of a handle. ]
]
[
- [[link boost_asio.reference.stream_socket_service.native_type [*native_type]]]
- [(Deprecated: Use native_handle_type.) The native socket type. ]
+ [[link boost_asio.reference.windows__basic_handle.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a handle. ]
]
[
- [[link boost_asio.reference.stream_socket_service.protocol_type [*protocol_type]]]
- [The protocol type. ]
+ [[link boost_asio.reference.windows__basic_handle.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
]
@@ -85048,267 +89135,141 @@
[[Name][Description]]
[
- [[link boost_asio.reference.stream_socket_service.assign [*assign]]]
- [Assign an existing native socket to a stream socket. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.async_connect [*async_connect]]]
- [Start an asynchronous connect. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.async_receive [*async_receive]]]
- [Start an asynchronous receive. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.async_send [*async_send]]]
- [Start an asynchronous send. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.at_mark [*at_mark]]]
- [Determine whether the socket is at the out-of-band data mark. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.available [*available]]]
- [Determine the number of bytes available for reading. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.bind [*bind]]]
- [Bind the stream socket to the specified local endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.cancel [*cancel]]]
- [Cancel all asynchronous operations associated with the socket. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.close [*close]]]
- [Close a stream socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.connect [*connect]]]
- [Connect the stream socket to the specified endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.construct [*construct]]]
- [Construct a new stream socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.destroy [*destroy]]]
- [Destroy a stream socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.assign [*assign]]]
+ [Assign an existing native handle to the handle. ]
]
[
- [[link boost_asio.reference.stream_socket_service.get_io_service [*get_io_service]]]
- [Get the io_service object that owns the service. ]
+ [[link boost_asio.reference.windows__basic_handle.basic_handle [*basic_handle]]]
+ [Construct a basic_handle without opening it.
+
+ Construct a basic_handle on an existing native handle.
+
+ Move-construct a basic_handle from another. ]
]
[
- [[link boost_asio.reference.stream_socket_service.get_option [*get_option]]]
- [Get a socket option. ]
+ [[link boost_asio.reference.windows__basic_handle.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the handle. ]
]
[
- [[link boost_asio.reference.stream_socket_service.io_control [*io_control]]]
- [Perform an IO control command on the socket. ]
+ [[link boost_asio.reference.windows__basic_handle.close [*close]]]
+ [Close the handle. ]
]
[
- [[link boost_asio.reference.stream_socket_service.is_open [*is_open]]]
- [Determine whether the socket is open. ]
+ [[link boost_asio.reference.windows__basic_handle.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.stream_socket_service.local_endpoint [*local_endpoint]]]
- [Get the local endpoint. ]
+ [[link boost_asio.reference.windows__basic_handle.is_open [*is_open]]]
+ [Determine whether the handle is open. ]
]
[
- [[link boost_asio.reference.stream_socket_service.move_assign [*move_assign]]]
- [Move-assign from another stream socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.stream_socket_service.move_construct [*move_construct]]]
- [Move-construct a new stream socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native handle representation. ]
]
[
- [[link boost_asio.reference.stream_socket_service.native [*native]]]
- [(Deprecated: Use native_handle().) Get the native socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.native_handle [*native_handle]]]
+ [Get the native handle representation. ]
]
[
- [[link boost_asio.reference.stream_socket_service.native_handle [*native_handle]]]
- [Get the native socket implementation. ]
+ [[link boost_asio.reference.windows__basic_handle.operator_eq_ [*operator=]]]
+ [Move-assign a basic_handle from another. ]
]
- [
- [[link boost_asio.reference.stream_socket_service.native_non_blocking [*native_non_blocking]]]
- [Gets the non-blocking mode of the native socket implementation.
+]
- Sets the non-blocking mode of the native socket implementation. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.non_blocking [*non_blocking]]]
- [Gets the non-blocking mode of the socket.
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
- Sets the non-blocking mode of the socket. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.open [*open]]]
- [Open a stream socket. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.receive [*receive]]]
- [Receive some data from the peer. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.remote_endpoint [*remote_endpoint]]]
- [Get the remote endpoint. ]
- ]
-
- [
- [[link boost_asio.reference.stream_socket_service.send [*send]]]
- [Send the given data to the peer. ]
- ]
-
[
- [[link boost_asio.reference.stream_socket_service.set_option [*set_option]]]
- [Set a socket option. ]
+ [[link boost_asio.reference.windows__basic_handle.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.stream_socket_service.shutdown [*shutdown]]]
- [Disable sends or receives on the socket. ]
+ [[link boost_asio.reference.windows__basic_handle.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
]
[
- [[link boost_asio.reference.stream_socket_service.stream_socket_service [*stream_socket_service]]]
- [Construct a new stream socket service for the specified io_service. ]
+ [[link boost_asio.reference.windows__basic_handle._basic_handle [*~basic_handle]]]
+ [Protected destructor to prevent deletion through this type. ]
]
]
-[heading Data Members]
+[heading Protected Data Members]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.stream_socket_service.id [*id]]]
- [The unique service identifier. ]
+ [[link boost_asio.reference.windows__basic_handle.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
]
-]
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/stream_socket_service.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[section:assign stream_socket_service::assign]
-
-[indexterm2 assign..stream_socket_service]
-Assign an existing native socket to a stream socket.
-
-
- boost::system::error_code assign(
- implementation_type & impl,
- const protocol_type & protocol,
- const native_handle_type & native_socket,
- boost::system::error_code & ec);
-
-
-
-[endsect]
-
-
-
-[section:async_connect stream_socket_service::async_connect]
-
-[indexterm2 async_connect..stream_socket_service]
-Start an asynchronous connect.
-
-
- template<
- typename ``[link boost_asio.reference.ConnectHandler ConnectHandler]``>
- void async_connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- ConnectHandler handler);
-
-
-
-[endsect]
-
-
-
-[section:async_receive stream_socket_service::async_receive]
+ [
+ [[link boost_asio.reference.windows__basic_handle.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
-[indexterm2 async_receive..stream_socket_service]
-Start an asynchronous receive.
+]
+The [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] class template provides the ability to wrap a Windows handle.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``,
- typename ``[link boost_asio.reference.ReadHandler ReadHandler]``>
- void async_receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- ReadHandler handler);
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
-[endsect]
+[heading Requirements]
-[section:async_send stream_socket_service::async_send]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
-[indexterm2 async_send..stream_socket_service]
-Start an asynchronous send.
+[*Convenience header: ][^boost/asio.hpp]
+[section:assign windows::basic_handle::assign]
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``,
- typename ``[link boost_asio.reference.WriteHandler WriteHandler]``>
- void async_send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- WriteHandler handler);
+[indexterm2 assign..windows::basic_handle]
+Assign an existing native handle to the handle.
+ void ``[link boost_asio.reference.windows__basic_handle.assign.overload1 assign]``(
+ const native_handle_type & handle);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.assign.overload1 more...]]``
-[endsect]
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.assign.overload2 assign]``(
+ const native_handle_type & handle,
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.assign.overload2 more...]]``
+[section:overload1 windows::basic_handle::assign (1 of 2 overloads)]
-[section:at_mark stream_socket_service::at_mark]
-[indexterm2 at_mark..stream_socket_service]
-Determine whether the socket is at the out-of-band data mark.
+Assign an existing native handle to the handle.
- bool at_mark(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+ void assign(
+ const native_handle_type & handle);
@@ -85316,31 +89277,14 @@
-[section:available stream_socket_service::available]
-
-[indexterm2 available..stream_socket_service]
-Determine the number of bytes available for reading.
-
-
- std::size_t available(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
-
-
-
-[endsect]
-
-
+[section:overload2 windows::basic_handle::assign (2 of 2 overloads)]
-[section:bind stream_socket_service::bind]
-[indexterm2 bind..stream_socket_service]
-Bind the stream socket to the specified local endpoint.
+Assign an existing native handle to the handle.
- boost::system::error_code bind(
- implementation_type & impl,
- const endpoint_type & endpoint,
+ boost::system::error_code assign(
+ const native_handle_type & handle,
boost::system::error_code & ec);
@@ -85348,79 +89292,58 @@
[endsect]
-
-[section:cancel stream_socket_service::cancel]
-
-[indexterm2 cancel..stream_socket_service]
-Cancel all asynchronous operations associated with the socket.
-
-
- boost::system::error_code cancel(
- implementation_type & impl,
- boost::system::error_code & ec);
-
-
-
[endsect]
+[section:basic_handle windows::basic_handle::basic_handle]
-
-[section:close stream_socket_service::close]
-
-[indexterm2 close..stream_socket_service]
-Close a stream socket implementation.
-
-
- boost::system::error_code close(
- implementation_type & impl,
- boost::system::error_code & ec);
-
-
-
-[endsect]
-
+[indexterm2 basic_handle..windows::basic_handle]
+Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] without opening it.
-[section:connect stream_socket_service::connect]
+ explicit ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload1 basic_handle]``(
+ boost::asio::io_service & io_service);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload1 more...]]``
-[indexterm2 connect..stream_socket_service]
-Connect the stream socket to the specified endpoint.
+Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] on an existing native handle.
- boost::system::error_code connect(
- implementation_type & impl,
- const endpoint_type & peer_endpoint,
- boost::system::error_code & ec);
+ ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload2 basic_handle]``(
+ boost::asio::io_service & io_service,
+ const native_handle_type & handle);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload2 more...]]``
-[endsect]
+Move-construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
+ ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload3 basic_handle]``(
+ basic_handle && other);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload3 more...]]``
-[section:construct stream_socket_service::construct]
-[indexterm2 construct..stream_socket_service]
-Construct a new stream socket implementation.
+[section:overload1 windows::basic_handle::basic_handle (1 of 3 overloads)]
- void construct(
- implementation_type & impl);
+Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] without opening it.
+ basic_handle(
+ boost::asio::io_service & io_service);
-[endsect]
+This constructor creates a handle without opening it.
-[section:destroy stream_socket_service::destroy]
+[heading Parameters]
+
-[indexterm2 destroy..stream_socket_service]
-Destroy a stream socket implementation.
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the handle will use to dispatch handlers for any asynchronous operations performed on the handle. ]]
+]
- void destroy(
- implementation_type & impl);
@@ -85428,37 +89351,41 @@
-[section:endpoint_type stream_socket_service::endpoint_type]
-
-[indexterm2 endpoint_type..stream_socket_service]
-The endpoint type.
-
+[section:overload2 windows::basic_handle::basic_handle (2 of 3 overloads)]
- typedef Protocol::endpoint endpoint_type;
+Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] on an existing native handle.
-[heading Requirements]
+ basic_handle(
+ boost::asio::io_service & io_service,
+ const native_handle_type & handle);
-[*Header: ][^boost/asio/stream_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
+This constructor creates a handle object to hold an existing native handle.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the handle will use to dispatch handlers for any asynchronous operations performed on the handle.]]
+[[handle][A native handle.]]
-[section:get_io_service stream_socket_service::get_io_service]
+]
-['Inherited from io_service.]
+[heading Exceptions]
+
-[indexterm2 get_io_service..stream_socket_service]
-Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
- boost::asio::io_service & get_io_service();
@@ -85466,87 +89393,76 @@
-[section:get_option stream_socket_service::get_option]
-
-[indexterm2 get_option..stream_socket_service]
-Get a socket option.
-
-
- template<
- typename ``[link boost_asio.reference.GettableSocketOption GettableSocketOption]``>
- boost::system::error_code get_option(
- const implementation_type & impl,
- GettableSocketOption & option,
- boost::system::error_code & ec) const;
-
-
-
-[endsect]
-
+[section:overload3 windows::basic_handle::basic_handle (3 of 3 overloads)]
-[section:id stream_socket_service::id]
+Move-construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
-[indexterm2 id..stream_socket_service]
-The unique service identifier.
+ basic_handle(
+ basic_handle && other);
- static boost::asio::io_service::id id;
+This constructor moves a handle from one object to another.
-[endsect]
+[heading Parameters]
+
+[variablelist
+
+[[other][The other [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] object from which the move will occur.]]
+]
-[section:implementation_type stream_socket_service::implementation_type]
-[indexterm2 implementation_type..stream_socket_service]
-The type of a stream socket implementation.
+[heading Remarks]
+
+Following the move, the moved-from object is in the same state as if constructed using the `basic_handle(io_service&) constructor`.
- typedef implementation_defined implementation_type;
+[endsect]
-[heading Requirements]
-[*Header: ][^boost/asio/stream_socket_service.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
+[section:cancel windows::basic_handle::cancel]
+[indexterm2 cancel..windows::basic_handle]
+Cancel all asynchronous operations associated with the handle.
-[endsect]
+ void ``[link boost_asio.reference.windows__basic_handle.cancel.overload1 cancel]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.cancel.overload1 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.cancel.overload2 cancel]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.cancel.overload2 more...]]``
-[section:io_control stream_socket_service::io_control]
-[indexterm2 io_control..stream_socket_service]
-Perform an IO control command on the socket.
+[section:overload1 windows::basic_handle::cancel (1 of 2 overloads)]
- template<
- typename ``[link boost_asio.reference.IoControlCommand IoControlCommand]``>
- boost::system::error_code io_control(
- implementation_type & impl,
- IoControlCommand & command,
- boost::system::error_code & ec);
+Cancel all asynchronous operations associated with the handle.
+ void cancel();
-[endsect]
+This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
-[section:is_open stream_socket_service::is_open]
+[heading Exceptions]
+
-[indexterm2 is_open..stream_socket_service]
-Determine whether the socket is open.
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
- bool is_open(
- const implementation_type & impl) const;
@@ -85554,134 +89470,131 @@
-[section:local_endpoint stream_socket_service::local_endpoint]
-
-[indexterm2 local_endpoint..stream_socket_service]
-Get the local endpoint.
+[section:overload2 windows::basic_handle::cancel (2 of 2 overloads)]
- endpoint_type local_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
+Cancel all asynchronous operations associated with the handle.
+ boost::system::error_code cancel(
+ boost::system::error_code & ec);
-[endsect]
+This function causes all outstanding asynchronous read or write operations to finish immediately, and the handlers for cancelled operations will be passed the `boost::asio::error::operation_aborted` error.
-[section:move_assign stream_socket_service::move_assign]
+[heading Parameters]
+
-[indexterm2 move_assign..stream_socket_service]
-Move-assign from another stream socket implementation.
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any. ]]
+]
- void move_assign(
- implementation_type & impl,
- stream_socket_service & other_service,
- implementation_type & other_impl);
[endsect]
+[endsect]
-[section:move_construct stream_socket_service::move_construct]
+[section:close windows::basic_handle::close]
-[indexterm2 move_construct..stream_socket_service]
-Move-construct a new stream socket implementation.
+[indexterm2 close..windows::basic_handle]
+Close the handle.
- void move_construct(
- implementation_type & impl,
- implementation_type & other_impl);
+ void ``[link boost_asio.reference.windows__basic_handle.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.close.overload1 more...]]``
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.close.overload2 close]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.close.overload2 more...]]``
-[endsect]
+[section:overload1 windows::basic_handle::close (1 of 2 overloads)]
+Close the handle.
-[section:native stream_socket_service::native]
-[indexterm2 native..stream_socket_service]
-(Deprecated: Use `native_handle()`.) Get the native socket implementation.
+ void close();
- native_type native(
- implementation_type & impl);
+This function is used to close the handle. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
+[heading Exceptions]
+
-[endsect]
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+]
-[section:native_handle stream_socket_service::native_handle]
-[indexterm2 native_handle..stream_socket_service]
-Get the native socket implementation.
+[endsect]
- native_handle_type native_handle(
- implementation_type & impl);
+[section:overload2 windows::basic_handle::close (2 of 2 overloads)]
-[endsect]
+Close the handle.
-[section:native_handle_type stream_socket_service::native_handle_type]
+ boost::system::error_code close(
+ boost::system::error_code & ec);
-[indexterm2 native_handle_type..stream_socket_service]
-The native socket type.
+This function is used to close the handle. Any asynchronous read or write operations will be cancelled immediately, and will complete with the `boost::asio::error::operation_aborted` error.
- typedef implementation_defined native_handle_type;
+[heading Parameters]
+
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any. ]]
-[heading Requirements]
+]
-[*Header: ][^boost/asio/stream_socket_service.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:native_non_blocking stream_socket_service::native_non_blocking]
+[endsect]
-[indexterm2 native_non_blocking..stream_socket_service]
-Gets the non-blocking mode of the native socket implementation.
+[section:get_implementation windows::basic_handle::get_implementation]
+[indexterm2 get_implementation..windows::basic_handle]
+Get the underlying implementation of the I/O object.
- bool ``[link boost_asio.reference.stream_socket_service.native_non_blocking.overload1 native_non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.stream_socket_service.native_non_blocking.overload1 more...]]``
+ implementation_type & ``[link boost_asio.reference.windows__basic_handle.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_implementation.overload1 more...]]``
-Sets the non-blocking mode of the native socket implementation.
+ const implementation_type & ``[link boost_asio.reference.windows__basic_handle.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_implementation.overload2 more...]]``
- boost::system::error_code ``[link boost_asio.reference.stream_socket_service.native_non_blocking.overload2 native_non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.stream_socket_service.native_non_blocking.overload2 more...]]``
+[section:overload1 windows::basic_handle::get_implementation (1 of 2 overloads)]
-[section:overload1 stream_socket_service::native_non_blocking (1 of 2 overloads)]
+['Inherited from basic_io_object.]
-Gets the non-blocking mode of the native socket implementation.
+Get the underlying implementation of the I/O object.
- bool native_non_blocking(
- const implementation_type & impl) const;
+ implementation_type & get_implementation();
@@ -85689,16 +89602,16 @@
-[section:overload2 stream_socket_service::native_non_blocking (2 of 2 overloads)]
+[section:overload2 windows::basic_handle::get_implementation (2 of 2 overloads)]
-Sets the non-blocking mode of the native socket implementation.
+['Inherited from basic_io_object.]
- boost::system::error_code native_non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+Get the underlying implementation of the I/O object.
+
+
+ const implementation_type & get_implementation() const;
@@ -85708,55 +89621,54 @@
[endsect]
-[section:native_type stream_socket_service::native_type]
+[section:get_io_service windows::basic_handle::get_io_service]
-[indexterm2 native_type..stream_socket_service]
-(Deprecated: Use native\_handle\_type.) The native socket type.
+['Inherited from basic_io_object.]
- typedef implementation_defined native_type;
+[indexterm2 get_io_service..windows::basic_handle]
+Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
+ boost::asio::io_service & get_io_service();
-[heading Requirements]
-[*Header: ][^boost/asio/stream_socket_service.hpp]
+This function may be used to obtain the [link boost_asio.reference.io_service `io_service`] object that the I/O object uses to dispatch handlers for asynchronous operations.
-[*Convenience header: ][^boost/asio.hpp]
+
+[heading Return Value]
+
+A reference to the [link boost_asio.reference.io_service `io_service`] object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.
-[endsect]
-[section:non_blocking stream_socket_service::non_blocking]
+[endsect]
-[indexterm2 non_blocking..stream_socket_service]
-Gets the non-blocking mode of the socket.
+[section:get_service windows::basic_handle::get_service]
- bool ``[link boost_asio.reference.stream_socket_service.non_blocking.overload1 non_blocking]``(
- const implementation_type & impl) const;
- `` [''''»''' [link boost_asio.reference.stream_socket_service.non_blocking.overload1 more...]]``
+[indexterm2 get_service..windows::basic_handle]
+Get the service associated with the I/O object.
-Sets the non-blocking mode of the socket.
+ service_type & ``[link boost_asio.reference.windows__basic_handle.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_service.overload1 more...]]``
+ const service_type & ``[link boost_asio.reference.windows__basic_handle.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_service.overload2 more...]]``
- boost::system::error_code ``[link boost_asio.reference.stream_socket_service.non_blocking.overload2 non_blocking]``(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.stream_socket_service.non_blocking.overload2 more...]]``
+[section:overload1 windows::basic_handle::get_service (1 of 2 overloads)]
-[section:overload1 stream_socket_service::non_blocking (1 of 2 overloads)]
+['Inherited from basic_io_object.]
-Gets the non-blocking mode of the socket.
+Get the service associated with the I/O object.
- bool non_blocking(
- const implementation_type & impl) const;
+
+ service_type & get_service();
@@ -85764,16 +89676,16 @@
-[section:overload2 stream_socket_service::non_blocking (2 of 2 overloads)]
+[section:overload2 windows::basic_handle::get_service (2 of 2 overloads)]
-Sets the non-blocking mode of the socket.
+['Inherited from basic_io_object.]
- boost::system::error_code non_blocking(
- implementation_type & impl,
- bool mode,
- boost::system::error_code & ec);
+Get the service associated with the I/O object.
+
+
+ const service_type & get_service() const;
@@ -85783,16 +89695,16 @@
[endsect]
-[section:open stream_socket_service::open]
+[section:implementation windows::basic_handle::implementation]
-[indexterm2 open..stream_socket_service]
-Open a stream socket.
+['Inherited from basic_io_object.]
- boost::system::error_code open(
- implementation_type & impl,
- const protocol_type & protocol,
- boost::system::error_code & ec);
+[indexterm2 implementation..windows::basic_handle]
+(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
+
+
+ implementation_type implementation;
@@ -85800,19 +89712,22 @@
-[section:protocol_type stream_socket_service::protocol_type]
+[section:implementation_type windows::basic_handle::implementation_type]
-[indexterm2 protocol_type..stream_socket_service]
-The protocol type.
+['Inherited from basic_io_object.]
+
+[indexterm2 implementation_type..windows::basic_handle]
+The underlying implementation type of I/O object.
- typedef Protocol protocol_type;
+
+ typedef service_type::implementation_type implementation_type;
[heading Requirements]
-[*Header: ][^boost/asio/stream_socket_service.hpp]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -85821,74 +89736,52 @@
-[section:receive stream_socket_service::receive]
+[section:is_open windows::basic_handle::is_open]
-[indexterm2 receive..stream_socket_service]
-Receive some data from the peer.
+[indexterm2 is_open..windows::basic_handle]
+Determine whether the handle is open.
- template<
- typename ``[link boost_asio.reference.MutableBufferSequence MutableBufferSequence]``>
- std::size_t receive(
- implementation_type & impl,
- const MutableBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+ bool is_open() const;
[endsect]
+[section:lowest_layer windows::basic_handle::lowest_layer]
-[section:remote_endpoint stream_socket_service::remote_endpoint]
-
-[indexterm2 remote_endpoint..stream_socket_service]
-Get the remote endpoint.
-
-
- endpoint_type remote_endpoint(
- const implementation_type & impl,
- boost::system::error_code & ec) const;
-
+[indexterm2 lowest_layer..windows::basic_handle]
+Get a reference to the lowest layer.
-[endsect]
+ lowest_layer_type & ``[link boost_asio.reference.windows__basic_handle.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.lowest_layer.overload1 more...]]``
+Get a const reference to the lowest layer.
-[section:send stream_socket_service::send]
-[indexterm2 send..stream_socket_service]
-Send the given data to the peer.
+ const lowest_layer_type & ``[link boost_asio.reference.windows__basic_handle.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_handle.lowest_layer.overload2 more...]]``
- template<
- typename ``[link boost_asio.reference.ConstBufferSequence ConstBufferSequence]``>
- std::size_t send(
- implementation_type & impl,
- const ConstBufferSequence & buffers,
- socket_base::message_flags flags,
- boost::system::error_code & ec);
+[section:overload1 windows::basic_handle::lowest_layer (1 of 2 overloads)]
+Get a reference to the lowest layer.
-[endsect]
+ lowest_layer_type & lowest_layer();
-[section:set_option stream_socket_service::set_option]
+This function returns a reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] cannot contain any further layers, it simply returns a reference to itself.
-[indexterm2 set_option..stream_socket_service]
-Set a socket option.
+[heading Return Value]
+
+A reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
- template<
- typename ``[link boost_asio.reference.SettableSocketOption SettableSocketOption]``>
- boost::system::error_code set_option(
- implementation_type & impl,
- const SettableSocketOption & option,
- boost::system::error_code & ec);
@@ -85896,48 +89789,38 @@
-[section:shutdown stream_socket_service::shutdown]
-
-[indexterm2 shutdown..stream_socket_service]
-Disable sends or receives on the socket.
-
-
- boost::system::error_code shutdown(
- implementation_type & impl,
- socket_base::shutdown_type what,
- boost::system::error_code & ec);
+[section:overload2 windows::basic_handle::lowest_layer (2 of 2 overloads)]
+Get a const reference to the lowest layer.
-[endsect]
+ const lowest_layer_type & lowest_layer() const;
-[section:stream_socket_service stream_socket_service::stream_socket_service]
+This function returns a const reference to the lowest layer in a stack of layers. Since a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] cannot contain any further layers, it simply returns a reference to itself.
-[indexterm2 stream_socket_service..stream_socket_service]
-Construct a new stream socket service for the specified [link boost_asio.reference.io_service `io_service`].
+[heading Return Value]
+
+A const reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.
- stream_socket_service(
- boost::asio::io_service & io_service);
[endsect]
-
[endsect]
-[section:streambuf streambuf]
+[section:lowest_layer_type windows::basic_handle::lowest_layer_type]
-[indexterm1 streambuf]
-Typedef for the typical usage of [link boost_asio.reference.basic_streambuf `basic_streambuf`].
+[indexterm2 lowest_layer_type..windows::basic_handle]
+A [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] is always the lowest layer.
- typedef basic_streambuf streambuf;
+ typedef basic_handle< HandleService > lowest_layer_type;
[heading Types]
@@ -85946,248 +89829,155 @@
[
- [[link boost_asio.reference.basic_streambuf.const_buffers_type [*const_buffers_type]]]
- [The type used to represent the input sequence as a list of buffers. ]
+ [[link boost_asio.reference.windows__basic_handle.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.basic_streambuf.mutable_buffers_type [*mutable_buffers_type]]]
- [The type used to represent the output sequence as a list of buffers. ]
+ [[link boost_asio.reference.windows__basic_handle.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_handle is always the lowest layer. ]
]
-]
+ [
-[heading Member Functions]
-[table
- [[Name][Description]]
+ [[link boost_asio.reference.windows__basic_handle.native_handle_type [*native_handle_type]]]
+ [The native representation of a handle. ]
+
+ ]
[
- [[link boost_asio.reference.basic_streambuf.basic_streambuf [*basic_streambuf]]]
- [Construct a basic_streambuf object. ]
- ]
+
+ [[link boost_asio.reference.windows__basic_handle.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a handle. ]
- [
- [[link boost_asio.reference.basic_streambuf.commit [*commit]]]
- [Move characters from the output sequence to the input sequence. ]
]
-
+
[
- [[link boost_asio.reference.basic_streambuf.consume [*consume]]]
- [Remove characters from the input sequence. ]
- ]
+
+ [[link boost_asio.reference.windows__basic_handle.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
- [
- [[link boost_asio.reference.basic_streambuf.data [*data]]]
- [Get a list of buffers that represents the input sequence. ]
]
-
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
[
- [[link boost_asio.reference.basic_streambuf.max_size [*max_size]]]
- [Get the maximum size of the basic_streambuf. ]
+ [[link boost_asio.reference.windows__basic_handle.assign [*assign]]]
+ [Assign an existing native handle to the handle. ]
]
[
- [[link boost_asio.reference.basic_streambuf.prepare [*prepare]]]
- [Get a list of buffers that represents the output sequence, with the given size. ]
+ [[link boost_asio.reference.windows__basic_handle.basic_handle [*basic_handle]]]
+ [Construct a basic_handle without opening it.
+
+ Construct a basic_handle on an existing native handle.
+
+ Move-construct a basic_handle from another. ]
]
[
- [[link boost_asio.reference.basic_streambuf.size [*size]]]
- [Get the size of the input sequence. ]
+ [[link boost_asio.reference.windows__basic_handle.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the handle. ]
]
-]
-
-[heading Protected Member Functions]
-[table
- [[Name][Description]]
-
[
- [[link boost_asio.reference.basic_streambuf.overflow [*overflow]]]
- [Override std::streambuf behaviour. ]
+ [[link boost_asio.reference.windows__basic_handle.close [*close]]]
+ [Close the handle. ]
]
[
- [[link boost_asio.reference.basic_streambuf.reserve [*reserve]]]
- []
+ [[link boost_asio.reference.windows__basic_handle.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.basic_streambuf.underflow [*underflow]]]
- [Override std::streambuf behaviour. ]
+ [[link boost_asio.reference.windows__basic_handle.is_open [*is_open]]]
+ [Determine whether the handle is open. ]
]
-]
-
-The `basic_streambuf` class is derived from `std::streambuf` to associate the streambuf's input and output sequences with one or more character arrays. These character arrays are internal to the `basic_streambuf` object, but direct access to the array elements is provided to permit them to be used efficiently with I/O operations. Characters written to the output sequence of a `basic_streambuf` object are appended to the input sequence of the same object.
-
-The `basic_streambuf` class's public interface is intended to permit the following implementation strategies:
-
-
-* A single contiguous character array, which is reallocated as necessary to accommodate changes in the size of the character sequence. This is the implementation approach currently used in Asio.
-
-
-* A sequence of one or more character arrays, where each array is of the same size. Additional character array objects are appended to the sequence to accommodate changes in the size of the character sequence.
-
-
-* A sequence of one or more character arrays of varying sizes. Additional character array objects are appended to the sequence to accommodate changes in the size of the character sequence.
-
-The constructor for [link boost_asio.reference.basic_streambuf `basic_streambuf`] accepts a `size_t` argument specifying the maximum of the sum of the sizes of the input sequence and output sequence. During the lifetime of the `basic_streambuf` object, the following invariant holds:
-
- size() <= max_size()
-
-
-Any member function that would, if successful, cause the invariant to be violated shall throw an exception of class `std::length_error`.
-
-The constructor for `basic_streambuf` takes an Allocator argument. A copy of this argument is used for any memory allocation performed, by the constructor and by all member functions, during the lifetime of each `basic_streambuf` object.
-
-
-[heading Examples]
-
-Writing directly from an streambuf to a socket:
-
- boost::asio::streambuf b;
- std::ostream os(&b);
- os << "Hello, World!\n";
-
- // try sending some data in input sequence
- size_t n = sock.send(b.data());
-
- b.consume(n); // sent data is removed from input sequence
-
-
-
-
-Reading from a socket directly into a streambuf:
-
- boost::asio::streambuf b;
-
- // reserve 512 bytes in output sequence
- boost::asio::streambuf::mutable_buffers_type bufs = b.prepare(512);
-
- size_t n = sock.receive(bufs);
-
- // received data is "committed" from output sequence to input sequence
- b.commit(n);
-
- std::istream is(&b);
- std::string s;
- is >> s;
-
-
-
-
-
-[heading Requirements]
-
-[*Header: ][^boost/asio/streambuf.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[endsect]
-
-
-[section:time_traits_lt__ptime__gt_ time_traits< boost::posix_time::ptime >]
-
-
-Time traits specialised for posix\_time.
-
-
- template<>
- struct time_traits< boost::posix_time::ptime >
-
-
-[heading Types]
-[table
- [[Name][Description]]
-
[
+ [[link boost_asio.reference.windows__basic_handle.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.duration_type [*duration_type]]]
- [The duration type. ]
+ Get a const reference to the lowest layer. ]
+ ]
+ [
+ [[link boost_asio.reference.windows__basic_handle.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native handle representation. ]
]
-
+
[
-
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.time_type [*time_type]]]
- [The time type. ]
+ [[link boost_asio.reference.windows__basic_handle.native_handle [*native_handle]]]
+ [Get the native handle representation. ]
+ ]
+ [
+ [[link boost_asio.reference.windows__basic_handle.operator_eq_ [*operator=]]]
+ [Move-assign a basic_handle from another. ]
]
-
+
]
-[heading Member Functions]
+[heading Protected Member Functions]
[table
[[Name][Description]]
[
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.add [*add]]]
- [Add a duration to a time. ]
- ]
-
- [
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.less_than [*less_than]]]
- [Test whether one time is less than another. ]
- ]
-
- [
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.now [*now]]]
- [Get the current time. ]
+ [[link boost_asio.reference.windows__basic_handle.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.subtract [*subtract]]]
- [Subtract one time from another. ]
+ [[link boost_asio.reference.windows__basic_handle.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
]
[
- [[link boost_asio.reference.time_traits_lt__ptime__gt_.to_posix_duration [*to_posix_duration]]]
- [Convert to POSIX duration type. ]
+ [[link boost_asio.reference.windows__basic_handle._basic_handle [*~basic_handle]]]
+ [Protected destructor to prevent deletion through this type. ]
]
]
-[heading Requirements]
-
-[*Header: ][^boost/asio/time_traits.hpp]
-
-[*Convenience header: ][^boost/asio.hpp]
-
-
-[section:add time_traits< boost::posix_time::ptime >::add]
-
-[indexterm2 add..time_traits< boost::posix_time::ptime >]
-Add a duration to a time.
-
-
- static time_type add(
- const time_type & t,
- const duration_type & d);
-
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+ [
+ [[link boost_asio.reference.windows__basic_handle.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
-[endsect]
+ [
+ [[link boost_asio.reference.windows__basic_handle.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+]
+The [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] class template provides the ability to wrap a Windows handle.
-[section:duration_type time_traits< boost::posix_time::ptime >::duration_type]
-[indexterm2 duration_type..time_traits< boost::posix_time::ptime >]
-The duration type.
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+[*Shared] [*objects:] Unsafe.
- typedef boost::posix_time::time_duration duration_type;
[heading Requirements]
-[*Header: ][^boost/asio/time_traits.hpp]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -86196,65 +89986,51 @@
-[section:less_than time_traits< boost::posix_time::ptime >::less_than]
-
-[indexterm2 less_than..time_traits< boost::posix_time::ptime >]
-Test whether one time is less than another.
-
-
- static bool less_than(
- const time_type & t1,
- const time_type & t2);
-
-
-
-[endsect]
-
-
+[section:native windows::basic_handle::native]
-[section:now time_traits< boost::posix_time::ptime >::now]
+[indexterm2 native..windows::basic_handle]
+(Deprecated: Use `native_handle()`.) Get the native handle representation.
-[indexterm2 now..time_traits< boost::posix_time::ptime >]
-Get the current time.
+ native_type native();
- static time_type now();
+This function may be used to obtain the underlying representation of the handle. This is intended to allow access to native handle functionality that is not otherwise provided.
[endsect]
-[section:subtract time_traits< boost::posix_time::ptime >::subtract]
+[section:native_handle windows::basic_handle::native_handle]
-[indexterm2 subtract..time_traits< boost::posix_time::ptime >]
-Subtract one time from another.
+[indexterm2 native_handle..windows::basic_handle]
+Get the native handle representation.
- static duration_type subtract(
- const time_type & t1,
- const time_type & t2);
+ native_handle_type native_handle();
+
+This function may be used to obtain the underlying representation of the handle. This is intended to allow access to native handle functionality that is not otherwise provided.
[endsect]
-[section:time_type time_traits< boost::posix_time::ptime >::time_type]
+[section:native_handle_type windows::basic_handle::native_handle_type]
-[indexterm2 time_type..time_traits< boost::posix_time::ptime >]
-The time type.
+[indexterm2 native_handle_type..windows::basic_handle]
+The native representation of a handle.
- typedef boost::posix_time::ptime time_type;
+ typedef HandleService::native_handle_type native_handle_type;
[heading Requirements]
-[*Header: ][^boost/asio/time_traits.hpp]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -86263,156 +90039,101 @@
-[section:to_posix_duration time_traits< boost::posix_time::ptime >::to_posix_duration]
-
-[indexterm2 to_posix_duration..time_traits< boost::posix_time::ptime >]
-Convert to POSIX duration type.
+[section:native_type windows::basic_handle::native_type]
+[indexterm2 native_type..windows::basic_handle]
+(Deprecated: Use native\_handle\_type.) The native representation of a handle.
- static boost::posix_time::time_duration to_posix_duration(
- const duration_type & d);
+ typedef HandleService::native_handle_type native_type;
-[endsect]
+[heading Requirements]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
-[endsect]
+[*Convenience header: ][^boost/asio.hpp]
-[section:transfer_all transfer_all]
+[endsect]
-[indexterm1 transfer_all]
-Return a completion condition function object that indicates that a read or write operation should continue until all of the data has been transferred, or until an error occurs.
- unspecified transfer_all();
+[section:operator_eq_ windows::basic_handle::operator=]
+[indexterm2 operator=..windows::basic_handle]
+Move-assign a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
-This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
+ basic_handle & operator=(
+ basic_handle && other);
-[heading Example]
-
-Reading until a buffer is full:
- boost::array<char, 128> buf;
- boost::system::error_code ec;
- std::size_t n = boost::asio::read(
- sock, boost::asio::buffer(buf),
- boost::asio::transfer_all(), ec);
- if (ec)
- {
- // An error occurred.
- }
- else
- {
- // n == 128
- }
+This assignment operator moves a handle from one object to another.
+[heading Parameters]
+
+[variablelist
+
+[[other][The other [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] object from which the move will occur.]]
+]
-[heading Requirements]
+[heading Remarks]
+
+Following the move, the moved-from object is in the same state as if constructed using the `basic_handle(io_service&) constructor`.
-[*Header: ][^boost/asio/completion_condition.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:transfer_at_least transfer_at_least]
-
-[indexterm1 transfer_at_least]
-Return a completion condition function object that indicates that a read or write operation should continue until a minimum number of bytes has been transferred, or until an error occurs.
-
-
- unspecified transfer_at_least(
- std::size_t minimum);
-
-
-This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
-
+[section:service windows::basic_handle::service]
-[heading Example]
-
-Reading until a buffer is full or contains at least 64 bytes:
- boost::array<char, 128> buf;
- boost::system::error_code ec;
- std::size_t n = boost::asio::read(
- sock, boost::asio::buffer(buf),
- boost::asio::transfer_at_least(64), ec);
- if (ec)
- {
- // An error occurred.
- }
- else
- {
- // n >= 64 && n <= 128
- }
+['Inherited from basic_io_object.]
+[indexterm2 service..windows::basic_handle]
+(Deprecated: Use `get_service()`.) The service associated with the I/O object.
+ service_type & service;
-[heading Requirements]
+[heading Remarks]
+
+Available only for services that do not support movability.
-[*Header: ][^boost/asio/completion_condition.hpp]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-[section:transfer_exactly transfer_exactly]
-
-[indexterm1 transfer_exactly]
-Return a completion condition function object that indicates that a read or write operation should continue until an exact number of bytes has been transferred, or until an error occurs.
-
-
- unspecified transfer_exactly(
- std::size_t size);
-
-
-This function is used to create an object, of unspecified type, that meets CompletionCondition requirements.
-
+[section:service_type windows::basic_handle::service_type]
-[heading Example]
-
-Reading until a buffer is full or contains exactly 64 bytes:
- boost::array<char, 128> buf;
- boost::system::error_code ec;
- std::size_t n = boost::asio::read(
- sock, boost::asio::buffer(buf),
- boost::asio::transfer_exactly(64), ec);
- if (ec)
- {
- // An error occurred.
- }
- else
- {
- // n == 64
- }
+['Inherited from basic_io_object.]
+[indexterm2 service_type..windows::basic_handle]
+The type of the service that will be used to provide I/O operations.
+ typedef HandleService service_type;
[heading Requirements]
-[*Header: ][^boost/asio/completion_condition.hpp]
+[*Header: ][^boost/asio/windows/basic_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -86421,55 +90142,32 @@
-[section:use_service use_service]
-
-[indexterm1 use_service]
-
- template<
- typename ``[link boost_asio.reference.Service Service]``>
- Service & use_service(
- io_service & ios);
-
-
-This function is used to locate a service object that corresponds to the given service type. If there is no existing implementation of the service, then the [link boost_asio.reference.io_service `io_service`] will create a new instance of the service.
-
-
-[heading Parameters]
-
-
-[variablelist
-
-[[ios][The [link boost_asio.reference.io_service `io_service`] object that owns the service.]]
-
-]
+[section:_basic_handle windows::basic_handle::~basic_handle]
+[indexterm2 ~basic_handle..windows::basic_handle]
+Protected destructor to prevent deletion through this type.
-[heading Return Value]
-
-The service interface implementing the specified service type. Ownership of the service interface is not transferred to the caller.
+ ~basic_handle();
-[heading Requirements]
-[*Header: ][^boost/asio/io_service.hpp]
+[endsect]
-[*Convenience header: ][^boost/asio.hpp]
[endsect]
-
-[section:windows__basic_handle windows::basic_handle]
+[section:windows__basic_object_handle windows::basic_object_handle]
-Provides Windows handle functionality.
+Provides object-oriented handle functionality.
template<
- typename ``[link boost_asio.reference.HandleService HandleService]``>
- class basic_handle :
- public basic_io_object< HandleService >
+ typename ``[link boost_asio.reference.ObjectHandleService ObjectHandleService]`` = object_handle_service>
+ class basic_object_handle :
+ public windows::basic_handle< ObjectHandleService >
[heading Types]
@@ -86478,35 +90176,35 @@
[
- [[link boost_asio.reference.windows__basic_handle.implementation_type [*implementation_type]]]
+ [[link boost_asio.reference.windows__basic_object_handle.implementation_type [*implementation_type]]]
[The underlying implementation type of I/O object. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.lowest_layer_type [*lowest_layer_type]]]
+ [[link boost_asio.reference.windows__basic_object_handle.lowest_layer_type [*lowest_layer_type]]]
[A basic_handle is always the lowest layer. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.native_handle_type [*native_handle_type]]]
+ [[link boost_asio.reference.windows__basic_object_handle.native_handle_type [*native_handle_type]]]
[The native representation of a handle. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.native_type [*native_type]]]
+ [[link boost_asio.reference.windows__basic_object_handle.native_type [*native_type]]]
[(Deprecated: Use native_handle_type.) The native representation of a handle. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.service_type [*service_type]]]
+ [[link boost_asio.reference.windows__basic_object_handle.service_type [*service_type]]]
[The type of the service that will be used to provide I/O operations. ]
]
@@ -86518,59 +90216,69 @@
[[Name][Description]]
[
- [[link boost_asio.reference.windows__basic_handle.assign [*assign]]]
+ [[link boost_asio.reference.windows__basic_object_handle.assign [*assign]]]
[Assign an existing native handle to the handle. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.basic_handle [*basic_handle]]]
- [Construct a basic_handle without opening it.
+ [[link boost_asio.reference.windows__basic_object_handle.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the object handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.basic_object_handle [*basic_object_handle]]]
+ [Construct a basic_object_handle without opening it.
- Construct a basic_handle on an existing native handle.
+ Construct a basic_object_handle on an existing native handle.
- Move-construct a basic_handle from another. ]
+ Move-construct a basic_object_handle from another. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.cancel [*cancel]]]
+ [[link boost_asio.reference.windows__basic_object_handle.cancel [*cancel]]]
[Cancel all asynchronous operations associated with the handle. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.close [*close]]]
+ [[link boost_asio.reference.windows__basic_object_handle.close [*close]]]
[Close the handle. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.get_io_service [*get_io_service]]]
+ [[link boost_asio.reference.windows__basic_object_handle.get_io_service [*get_io_service]]]
[Get the io_service associated with the object. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.is_open [*is_open]]]
+ [[link boost_asio.reference.windows__basic_object_handle.is_open [*is_open]]]
[Determine whether the handle is open. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.lowest_layer [*lowest_layer]]]
+ [[link boost_asio.reference.windows__basic_object_handle.lowest_layer [*lowest_layer]]]
[Get a reference to the lowest layer.
Get a const reference to the lowest layer. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.native [*native]]]
+ [[link boost_asio.reference.windows__basic_object_handle.native [*native]]]
[(Deprecated: Use native_handle().) Get the native handle representation. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.native_handle [*native_handle]]]
+ [[link boost_asio.reference.windows__basic_object_handle.native_handle [*native_handle]]]
[Get the native handle representation. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.operator_eq_ [*operator=]]]
- [Move-assign a basic_handle from another. ]
+ [[link boost_asio.reference.windows__basic_object_handle.operator_eq_ [*operator=]]]
+ [Move-assign a basic_object_handle from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.wait [*wait]]]
+ [Perform a blocking wait on the object handle. ]
]
]
@@ -86580,20 +90288,15 @@
[[Name][Description]]
[
- [[link boost_asio.reference.windows__basic_handle.get_implementation [*get_implementation]]]
+ [[link boost_asio.reference.windows__basic_object_handle.get_implementation [*get_implementation]]]
[Get the underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.get_service [*get_service]]]
+ [[link boost_asio.reference.windows__basic_object_handle.get_service [*get_service]]]
[Get the service associated with the I/O object. ]
]
- [
- [[link boost_asio.reference.windows__basic_handle._basic_handle [*~basic_handle]]]
- [Protected destructor to prevent deletion through this type. ]
- ]
-
]
[heading Protected Data Members]
@@ -86601,18 +90304,18 @@
[[Name][Description]]
[
- [[link boost_asio.reference.windows__basic_handle.implementation [*implementation]]]
+ [[link boost_asio.reference.windows__basic_object_handle.implementation [*implementation]]]
[(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
]
[
- [[link boost_asio.reference.windows__basic_handle.service [*service]]]
+ [[link boost_asio.reference.windows__basic_object_handle.service [*service]]]
[(Deprecated: Use get_service().) The service associated with the I/O object. ]
]
]
-The [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] class template provides the ability to wrap a Windows handle.
+The [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] class template provides asynchronous and blocking object-oriented handle functionality.
[heading Thread Safety]
@@ -86625,27 +90328,30 @@
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
-[section:assign windows::basic_handle::assign]
+[section:assign windows::basic_object_handle::assign]
-[indexterm2 assign..windows::basic_handle]
+[indexterm2 assign..windows::basic_object_handle]
Assign an existing native handle to the handle.
- void ``[link boost_asio.reference.windows__basic_handle.assign.overload1 assign]``(
+ void ``[link boost_asio.reference.windows__basic_object_handle.assign.overload1 assign]``(
const native_handle_type & handle);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.assign.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.assign.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.assign.overload2 assign]``(
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_object_handle.assign.overload2 assign]``(
const native_handle_type & handle,
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.assign.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.assign.overload2 more...]]``
-[section:overload1 windows::basic_handle::assign (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::assign (1 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Assign an existing native handle to the handle.
@@ -86660,7 +90366,10 @@
-[section:overload2 windows::basic_handle::assign (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::assign (2 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Assign an existing native handle to the handle.
@@ -86677,45 +90386,82 @@
[endsect]
-[section:basic_handle windows::basic_handle::basic_handle]
-[indexterm2 basic_handle..windows::basic_handle]
-Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] without opening it.
+[section:async_wait windows::basic_object_handle::async_wait]
+[indexterm2 async_wait..windows::basic_object_handle]
+Start an asynchronous wait on the object handle.
- explicit ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload1 basic_handle]``(
+
+ template<
+ typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
+ void async_wait(
+ WaitHandler handler);
+
+
+This function is be used to initiate an asynchronous wait against the object handle. It always returns immediately.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[handler][The handler to be called when the object handle is set to the signalled state. Copies will be made of the handler as required. The function signature of the handler must be:
+``
+ void handler(
+ const boost::system::error_code& error // Result of operation.
+ );
+``
+Regardless of whether the asynchronous operation completes immediately or not, the handler will not be invoked from within this function. Invocation of the handler will be performed in a manner equivalent to using `boost::asio::io_service::post()`. ]]
+
+]
+
+
+
+
+[endsect]
+
+
+[section:basic_object_handle windows::basic_object_handle::basic_object_handle]
+
+[indexterm2 basic_object_handle..windows::basic_object_handle]
+Construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] without opening it.
+
+
+ explicit ``[link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload1 basic_object_handle]``(
boost::asio::io_service & io_service);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload1 more...]]``
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload1 more...]]``
-Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] on an existing native handle.
+Construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] on an existing native handle.
- ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload2 basic_handle]``(
+ ``[link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload2 basic_object_handle]``(
boost::asio::io_service & io_service,
- const native_handle_type & handle);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload2 more...]]``
+ const native_handle_type & native_handle);
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload2 more...]]``
-Move-construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
+Move-construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] from another.
- ``[link boost_asio.reference.windows__basic_handle.basic_handle.overload3 basic_handle]``(
- basic_handle && other);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.basic_handle.overload3 more...]]``
+ ``[link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload3 basic_object_handle]``(
+ basic_object_handle && other);
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.basic_object_handle.overload3 more...]]``
-[section:overload1 windows::basic_handle::basic_handle (1 of 3 overloads)]
+[section:overload1 windows::basic_object_handle::basic_object_handle (1 of 3 overloads)]
-Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] without opening it.
+Construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] without opening it.
- basic_handle(
+ basic_object_handle(
boost::asio::io_service & io_service);
-This constructor creates a handle without opening it.
+This constructor creates an object handle without opening it.
[heading Parameters]
@@ -86723,7 +90469,7 @@
[variablelist
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the handle will use to dispatch handlers for any asynchronous operations performed on the handle. ]]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the object handle will use to dispatch handlers for any asynchronous operations performed on the handle. ]]
]
@@ -86734,18 +90480,18 @@
-[section:overload2 windows::basic_handle::basic_handle (2 of 3 overloads)]
+[section:overload2 windows::basic_object_handle::basic_object_handle (2 of 3 overloads)]
-Construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] on an existing native handle.
+Construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] on an existing native handle.
- basic_handle(
+ basic_object_handle(
boost::asio::io_service & io_service,
- const native_handle_type & handle);
+ const native_handle_type & native_handle);
-This constructor creates a handle object to hold an existing native handle.
+This constructor creates an object handle object to hold an existing native handle.
[heading Parameters]
@@ -86753,9 +90499,9 @@
[variablelist
-[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the handle will use to dispatch handlers for any asynchronous operations performed on the handle.]]
+[[io_service][The [link boost_asio.reference.io_service `io_service`] object that the object handle will use to dispatch handlers for any asynchronous operations performed on the handle.]]
-[[handle][A native handle.]]
+[[native_handle][The new underlying handle implementation.]]
]
@@ -86776,17 +90522,17 @@
-[section:overload3 windows::basic_handle::basic_handle (3 of 3 overloads)]
+[section:overload3 windows::basic_object_handle::basic_object_handle (3 of 3 overloads)]
-Move-construct a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
+Move-construct a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] from another.
- basic_handle(
- basic_handle && other);
+ basic_object_handle(
+ basic_object_handle && other);
-This constructor moves a handle from one object to another.
+This constructor moves an object handle from one object to another.
[heading Parameters]
@@ -86794,14 +90540,14 @@
[variablelist
-[[other][The other [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] object from which the move will occur.]]
+[[other][The other [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] object from which the move will occur.]]
]
[heading Remarks]
-Following the move, the moved-from object is in the same state as if constructed using the `basic_handle(io_service&) constructor`.
+Following the move, the moved-from object is in the same state as if constructed using the `basic_object_handle(io_service&) constructor`.
@@ -86811,21 +90557,24 @@
[endsect]
-[section:cancel windows::basic_handle::cancel]
+[section:cancel windows::basic_object_handle::cancel]
-[indexterm2 cancel..windows::basic_handle]
+[indexterm2 cancel..windows::basic_object_handle]
Cancel all asynchronous operations associated with the handle.
- void ``[link boost_asio.reference.windows__basic_handle.cancel.overload1 cancel]``();
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.cancel.overload1 more...]]``
+ void ``[link boost_asio.reference.windows__basic_object_handle.cancel.overload1 cancel]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.cancel.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.cancel.overload2 cancel]``(
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_object_handle.cancel.overload2 cancel]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.cancel.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.cancel.overload2 more...]]``
-[section:overload1 windows::basic_handle::cancel (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::cancel (1 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Cancel all asynchronous operations associated with the handle.
@@ -86853,7 +90602,10 @@
-[section:overload2 windows::basic_handle::cancel (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::cancel (2 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Cancel all asynchronous operations associated with the handle.
@@ -86883,21 +90635,24 @@
[endsect]
-[section:close windows::basic_handle::close]
+[section:close windows::basic_object_handle::close]
-[indexterm2 close..windows::basic_handle]
+[indexterm2 close..windows::basic_object_handle]
Close the handle.
- void ``[link boost_asio.reference.windows__basic_handle.close.overload1 close]``();
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.close.overload1 more...]]``
+ void ``[link boost_asio.reference.windows__basic_object_handle.close.overload1 close]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.close.overload1 more...]]``
- boost::system::error_code ``[link boost_asio.reference.windows__basic_handle.close.overload2 close]``(
+ boost::system::error_code ``[link boost_asio.reference.windows__basic_object_handle.close.overload2 close]``(
boost::system::error_code & ec);
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.close.overload2 more...]]``
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.close.overload2 more...]]``
-[section:overload1 windows::basic_handle::close (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::close (1 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Close the handle.
@@ -86925,7 +90680,10 @@
-[section:overload2 windows::basic_handle::close (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::close (2 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Close the handle.
@@ -86955,20 +90713,20 @@
[endsect]
-[section:get_implementation windows::basic_handle::get_implementation]
+[section:get_implementation windows::basic_object_handle::get_implementation]
-[indexterm2 get_implementation..windows::basic_handle]
+[indexterm2 get_implementation..windows::basic_object_handle]
Get the underlying implementation of the I/O object.
- implementation_type & ``[link boost_asio.reference.windows__basic_handle.get_implementation.overload1 get_implementation]``();
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_implementation.overload1 more...]]``
+ implementation_type & ``[link boost_asio.reference.windows__basic_object_handle.get_implementation.overload1 get_implementation]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.get_implementation.overload1 more...]]``
- const implementation_type & ``[link boost_asio.reference.windows__basic_handle.get_implementation.overload2 get_implementation]``() const;
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_implementation.overload2 more...]]``
+ const implementation_type & ``[link boost_asio.reference.windows__basic_object_handle.get_implementation.overload2 get_implementation]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.get_implementation.overload2 more...]]``
-[section:overload1 windows::basic_handle::get_implementation (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::get_implementation (1 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -86985,7 +90743,7 @@
-[section:overload2 windows::basic_handle::get_implementation (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::get_implementation (2 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -87004,12 +90762,12 @@
[endsect]
-[section:get_io_service windows::basic_handle::get_io_service]
+[section:get_io_service windows::basic_object_handle::get_io_service]
['Inherited from basic_io_object.]
-[indexterm2 get_io_service..windows::basic_handle]
+[indexterm2 get_io_service..windows::basic_object_handle]
Get the [link boost_asio.reference.io_service `io_service`] associated with the object.
@@ -87029,20 +90787,20 @@
[endsect]
-[section:get_service windows::basic_handle::get_service]
+[section:get_service windows::basic_object_handle::get_service]
-[indexterm2 get_service..windows::basic_handle]
+[indexterm2 get_service..windows::basic_object_handle]
Get the service associated with the I/O object.
- service_type & ``[link boost_asio.reference.windows__basic_handle.get_service.overload1 get_service]``();
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_service.overload1 more...]]``
+ service_type & ``[link boost_asio.reference.windows__basic_object_handle.get_service.overload1 get_service]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.get_service.overload1 more...]]``
- const service_type & ``[link boost_asio.reference.windows__basic_handle.get_service.overload2 get_service]``() const;
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.get_service.overload2 more...]]``
+ const service_type & ``[link boost_asio.reference.windows__basic_object_handle.get_service.overload2 get_service]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.get_service.overload2 more...]]``
-[section:overload1 windows::basic_handle::get_service (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::get_service (1 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -87059,7 +90817,7 @@
-[section:overload2 windows::basic_handle::get_service (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::get_service (2 of 2 overloads)]
['Inherited from basic_io_object.]
@@ -87078,12 +90836,12 @@
[endsect]
-[section:implementation windows::basic_handle::implementation]
+[section:implementation windows::basic_object_handle::implementation]
['Inherited from basic_io_object.]
-[indexterm2 implementation..windows::basic_handle]
+[indexterm2 implementation..windows::basic_object_handle]
(Deprecated: Use `get_implementation()`.) The underlying implementation of the I/O object.
@@ -87095,12 +90853,12 @@
-[section:implementation_type windows::basic_handle::implementation_type]
+[section:implementation_type windows::basic_object_handle::implementation_type]
['Inherited from basic_io_object.]
-[indexterm2 implementation_type..windows::basic_handle]
+[indexterm2 implementation_type..windows::basic_object_handle]
The underlying implementation type of I/O object.
@@ -87110,7 +90868,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -87119,9 +90877,12 @@
-[section:is_open windows::basic_handle::is_open]
+[section:is_open windows::basic_object_handle::is_open]
-[indexterm2 is_open..windows::basic_handle]
+
+['Inherited from windows::basic_handle.]
+
+[indexterm2 is_open..windows::basic_object_handle]
Determine whether the handle is open.
@@ -87132,24 +90893,27 @@
[endsect]
-[section:lowest_layer windows::basic_handle::lowest_layer]
+[section:lowest_layer windows::basic_object_handle::lowest_layer]
-[indexterm2 lowest_layer..windows::basic_handle]
+[indexterm2 lowest_layer..windows::basic_object_handle]
Get a reference to the lowest layer.
- lowest_layer_type & ``[link boost_asio.reference.windows__basic_handle.lowest_layer.overload1 lowest_layer]``();
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.lowest_layer.overload1 more...]]``
+ lowest_layer_type & ``[link boost_asio.reference.windows__basic_object_handle.lowest_layer.overload1 lowest_layer]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.lowest_layer.overload1 more...]]``
Get a const reference to the lowest layer.
- const lowest_layer_type & ``[link boost_asio.reference.windows__basic_handle.lowest_layer.overload2 lowest_layer]``() const;
- `` [''''»''' [link boost_asio.reference.windows__basic_handle.lowest_layer.overload2 more...]]``
+ const lowest_layer_type & ``[link boost_asio.reference.windows__basic_object_handle.lowest_layer.overload2 lowest_layer]``() const;
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.lowest_layer.overload2 more...]]``
-[section:overload1 windows::basic_handle::lowest_layer (1 of 2 overloads)]
+[section:overload1 windows::basic_object_handle::lowest_layer (1 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Get a reference to the lowest layer.
@@ -87172,7 +90936,10 @@
-[section:overload2 windows::basic_handle::lowest_layer (2 of 2 overloads)]
+[section:overload2 windows::basic_object_handle::lowest_layer (2 of 2 overloads)]
+
+
+['Inherited from windows::basic_handle.]
Get a const reference to the lowest layer.
@@ -87197,13 +90964,16 @@
[endsect]
-[section:lowest_layer_type windows::basic_handle::lowest_layer_type]
+[section:lowest_layer_type windows::basic_object_handle::lowest_layer_type]
-[indexterm2 lowest_layer_type..windows::basic_handle]
+
+['Inherited from windows::basic_handle.]
+
+[indexterm2 lowest_layer_type..windows::basic_object_handle]
A [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] is always the lowest layer.
- typedef basic_handle< HandleService > lowest_layer_type;
+ typedef basic_handle< ObjectHandleService > lowest_layer_type;
[heading Types]
@@ -87360,7 +91130,7 @@
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -87369,9 +91139,12 @@
-[section:native windows::basic_handle::native]
+[section:native windows::basic_object_handle::native]
-[indexterm2 native..windows::basic_handle]
+
+['Inherited from windows::basic_handle.]
+
+[indexterm2 native..windows::basic_object_handle]
(Deprecated: Use `native_handle()`.) Get the native handle representation.
@@ -87385,9 +91158,12 @@
-[section:native_handle windows::basic_handle::native_handle]
+[section:native_handle windows::basic_object_handle::native_handle]
-[indexterm2 native_handle..windows::basic_handle]
+
+['Inherited from windows::basic_handle.]
+
+[indexterm2 native_handle..windows::basic_object_handle]
Get the native handle representation.
@@ -87401,19 +91177,19 @@
-[section:native_handle_type windows::basic_handle::native_handle_type]
+[section:native_handle_type windows::basic_object_handle::native_handle_type]
-[indexterm2 native_handle_type..windows::basic_handle]
+[indexterm2 native_handle_type..windows::basic_object_handle]
The native representation of a handle.
- typedef HandleService::native_handle_type native_handle_type;
+ typedef ObjectHandleService::native_handle_type native_handle_type;
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -87422,19 +91198,22 @@
-[section:native_type windows::basic_handle::native_type]
+[section:native_type windows::basic_object_handle::native_type]
-[indexterm2 native_type..windows::basic_handle]
+
+['Inherited from windows::basic_handle.]
+
+[indexterm2 native_type..windows::basic_object_handle]
(Deprecated: Use native\_handle\_type.) The native representation of a handle.
- typedef HandleService::native_handle_type native_type;
+ typedef ObjectHandleService::native_handle_type native_type;
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -87443,17 +91222,17 @@
-[section:operator_eq_ windows::basic_handle::operator=]
+[section:operator_eq_ windows::basic_object_handle::operator=]
-[indexterm2 operator=..windows::basic_handle]
-Move-assign a [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] from another.
+[indexterm2 operator=..windows::basic_object_handle]
+Move-assign a [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] from another.
- basic_handle & operator=(
- basic_handle && other);
+ basic_object_handle & operator=(
+ basic_object_handle && other);
-This assignment operator moves a handle from one object to another.
+This assignment operator moves an object handle from one object to another.
[heading Parameters]
@@ -87461,14 +91240,14 @@
[variablelist
-[[other][The other [link boost_asio.reference.windows__basic_handle `windows::basic_handle`] object from which the move will occur.]]
+[[other][The other [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] object from which the move will occur.]]
]
[heading Remarks]
-Following the move, the moved-from object is in the same state as if constructed using the `basic_handle(io_service&) constructor`.
+Following the move, the moved-from object is in the same state as if constructed using the `basic_object_handle(io_service&) constructor`.
@@ -87477,12 +91256,12 @@
-[section:service windows::basic_handle::service]
+[section:service windows::basic_object_handle::service]
['Inherited from basic_io_object.]
-[indexterm2 service..windows::basic_handle]
+[indexterm2 service..windows::basic_object_handle]
(Deprecated: Use `get_service()`.) The service associated with the I/O object.
@@ -87501,22 +91280,22 @@
-[section:service_type windows::basic_handle::service_type]
+[section:service_type windows::basic_object_handle::service_type]
['Inherited from basic_io_object.]
-[indexterm2 service_type..windows::basic_handle]
+[indexterm2 service_type..windows::basic_object_handle]
The type of the service that will be used to provide I/O operations.
- typedef HandleService service_type;
+ typedef ObjectHandleService service_type;
[heading Requirements]
-[*Header: ][^boost/asio/windows/basic_handle.hpp]
+[*Header: ][^boost/asio/windows/basic_object_handle.hpp]
[*Convenience header: ][^boost/asio.hpp]
@@ -87524,20 +91303,78 @@
[endsect]
+[section:wait windows::basic_object_handle::wait]
-[section:_basic_handle windows::basic_handle::~basic_handle]
+[indexterm2 wait..windows::basic_object_handle]
+Perform a blocking wait on the object handle.
-[indexterm2 ~basic_handle..windows::basic_handle]
-Protected destructor to prevent deletion through this type.
+
+ void ``[link boost_asio.reference.windows__basic_object_handle.wait.overload1 wait]``();
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.wait.overload1 more...]]``
+
+ void ``[link boost_asio.reference.windows__basic_object_handle.wait.overload2 wait]``(
+ boost::system::error_code & ec);
+ `` [''''»''' [link boost_asio.reference.windows__basic_object_handle.wait.overload2 more...]]``
+
+
+[section:overload1 windows::basic_object_handle::wait (1 of 2 overloads)]
+
+
+Perform a blocking wait on the object handle.
+
+
+ void wait();
+
+
+This function is used to wait for the object handle to be set to the signalled state. This function blocks and does not return until the object handle has been set to the signalled state.
+
+
+[heading Exceptions]
+
+
+[variablelist
+
+[[boost::system::system_error][Thrown on failure. ]]
+
+]
- ~basic_handle();
+
+
+[endsect]
+
+
+
+[section:overload2 windows::basic_object_handle::wait (2 of 2 overloads)]
+
+
+Perform a blocking wait on the object handle.
+
+
+ void wait(
+ boost::system::error_code & ec);
+
+
+This function is used to wait for the object handle to be set to the signalled state. This function blocks and does not return until the object handle has been set to the signalled state.
+
+
+[heading Parameters]
+
+
+[variablelist
+
+[[ec][Set to indicate what error occurred, if any. ]]
+
+]
+
[endsect]
+[endsect]
+
[endsect]
@@ -90532,6 +94369,566 @@
[endsect]
+
+[section:windows__object_handle windows::object_handle]
+
+[indexterm1 windows::object_handle]
+Typedef for the typical usage of an object handle.
+
+
+ typedef basic_object_handle object_handle;
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.windows__basic_object_handle.implementation_type [*implementation_type]]]
+ [The underlying implementation type of I/O object. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.windows__basic_object_handle.lowest_layer_type [*lowest_layer_type]]]
+ [A basic_handle is always the lowest layer. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.windows__basic_object_handle.native_handle_type [*native_handle_type]]]
+ [The native representation of a handle. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.windows__basic_object_handle.native_type [*native_type]]]
+ [(Deprecated: Use native_handle_type.) The native representation of a handle. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.windows__basic_object_handle.service_type [*service_type]]]
+ [The type of the service that will be used to provide I/O operations. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.assign [*assign]]]
+ [Assign an existing native handle to the handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.async_wait [*async_wait]]]
+ [Start an asynchronous wait on the object handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.basic_object_handle [*basic_object_handle]]]
+ [Construct a basic_object_handle without opening it.
+
+ Construct a basic_object_handle on an existing native handle.
+
+ Move-construct a basic_object_handle from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.close [*close]]]
+ [Close the handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.get_io_service [*get_io_service]]]
+ [Get the io_service associated with the object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.is_open [*is_open]]]
+ [Determine whether the handle is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.lowest_layer [*lowest_layer]]]
+ [Get a reference to the lowest layer.
+
+ Get a const reference to the lowest layer. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.native [*native]]]
+ [(Deprecated: Use native_handle().) Get the native handle representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.native_handle [*native_handle]]]
+ [Get the native handle representation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.operator_eq_ [*operator=]]]
+ [Move-assign a basic_object_handle from another. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.wait [*wait]]]
+ [Perform a blocking wait on the object handle. ]
+ ]
+
+]
+
+[heading Protected Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.get_implementation [*get_implementation]]]
+ [Get the underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.get_service [*get_service]]]
+ [Get the service associated with the I/O object. ]
+ ]
+
+]
+
+[heading Protected Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.implementation [*implementation]]]
+ [(Deprecated: Use get_implementation().) The underlying implementation of the I/O object. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__basic_object_handle.service [*service]]]
+ [(Deprecated: Use get_service().) The service associated with the I/O object. ]
+ ]
+
+]
+
+The [link boost_asio.reference.windows__basic_object_handle `windows::basic_object_handle`] class template provides asynchronous and blocking object-oriented handle functionality.
+
+
+[heading Thread Safety]
+
+[*Distinct] [*objects:] Safe.
+
+[*Shared] [*objects:] Unsafe.
+
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/windows/object_handle.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+[section:windows__object_handle_service windows::object_handle_service]
+
+
+Default service implementation for an object handle.
+
+
+ class object_handle_service :
+ public io_service::service
+
+
+[heading Types]
+[table
+ [[Name][Description]]
+
+ [
+
+ [[link boost_asio.reference.windows__object_handle_service.implementation_type [*implementation_type]]]
+ [The type of an object handle implementation. ]
+
+ ]
+
+ [
+
+ [[link boost_asio.reference.windows__object_handle_service.native_handle_type [*native_handle_type]]]
+ [The native handle type. ]
+
+ ]
+
+]
+
+[heading Member Functions]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.assign [*assign]]]
+ [Assign an existing native handle to an object handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.async_wait [*async_wait]]]
+ [Start an asynchronous wait. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.cancel [*cancel]]]
+ [Cancel all asynchronous operations associated with the handle. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.close [*close]]]
+ [Close an object handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.construct [*construct]]]
+ [Construct a new object handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.destroy [*destroy]]]
+ [Destroy an object handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.get_io_service [*get_io_service]]]
+ [Get the io_service object that owns the service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.is_open [*is_open]]]
+ [Determine whether the handle is open. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.move_assign [*move_assign]]]
+ [Move-assign from another object handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.move_construct [*move_construct]]]
+ [Move-construct a new object handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.native_handle [*native_handle]]]
+ [Get the native handle implementation. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.object_handle_service [*object_handle_service]]]
+ [Construct a new object handle service for the specified io_service. ]
+ ]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.wait [*wait]]]
+ []
+ ]
+
+]
+
+[heading Data Members]
+[table
+ [[Name][Description]]
+
+ [
+ [[link boost_asio.reference.windows__object_handle_service.id [*id]]]
+ [The unique service identifier. ]
+ ]
+
+]
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/windows/object_handle_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[section:assign windows::object_handle_service::assign]
+
+[indexterm2 assign..windows::object_handle_service]
+Assign an existing native handle to an object handle.
+
+
+ boost::system::error_code assign(
+ implementation_type & impl,
+ const native_handle_type & handle,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:async_wait windows::object_handle_service::async_wait]
+
+[indexterm2 async_wait..windows::object_handle_service]
+Start an asynchronous wait.
+
+
+ template<
+ typename ``[link boost_asio.reference.WaitHandler WaitHandler]``>
+ void async_wait(
+ implementation_type & impl,
+ WaitHandler handler);
+
+
+
+[endsect]
+
+
+
+[section:cancel windows::object_handle_service::cancel]
+
+[indexterm2 cancel..windows::object_handle_service]
+Cancel all asynchronous operations associated with the handle.
+
+
+ boost::system::error_code cancel(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:close windows::object_handle_service::close]
+
+[indexterm2 close..windows::object_handle_service]
+Close an object handle implementation.
+
+
+ boost::system::error_code close(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[section:construct windows::object_handle_service::construct]
+
+[indexterm2 construct..windows::object_handle_service]
+Construct a new object handle implementation.
+
+
+ void construct(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:destroy windows::object_handle_service::destroy]
+
+[indexterm2 destroy..windows::object_handle_service]
+Destroy an object handle implementation.
+
+
+ void destroy(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:get_io_service windows::object_handle_service::get_io_service]
+
+
+['Inherited from io_service.]
+
+[indexterm2 get_io_service..windows::object_handle_service]
+Get the [link boost_asio.reference.io_service `io_service`] object that owns the service.
+
+
+ boost::asio::io_service & get_io_service();
+
+
+
+[endsect]
+
+
+
+[section:id windows::object_handle_service::id]
+
+[indexterm2 id..windows::object_handle_service]
+The unique service identifier.
+
+
+ static boost::asio::io_service::id id;
+
+
+
+[endsect]
+
+
+
+[section:implementation_type windows::object_handle_service::implementation_type]
+
+[indexterm2 implementation_type..windows::object_handle_service]
+The type of an object handle implementation.
+
+
+ typedef implementation_defined implementation_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/windows/object_handle_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:is_open windows::object_handle_service::is_open]
+
+[indexterm2 is_open..windows::object_handle_service]
+Determine whether the handle is open.
+
+
+ bool is_open(
+ const implementation_type & impl) const;
+
+
+
+[endsect]
+
+
+
+[section:move_assign windows::object_handle_service::move_assign]
+
+[indexterm2 move_assign..windows::object_handle_service]
+Move-assign from another object handle implementation.
+
+
+ void move_assign(
+ implementation_type & impl,
+ object_handle_service & other_service,
+ implementation_type & other_impl);
+
+
+
+[endsect]
+
+
+
+[section:move_construct windows::object_handle_service::move_construct]
+
+[indexterm2 move_construct..windows::object_handle_service]
+Move-construct a new object handle implementation.
+
+
+ void move_construct(
+ implementation_type & impl,
+ implementation_type & other_impl);
+
+
+
+[endsect]
+
+
+
+[section:native_handle windows::object_handle_service::native_handle]
+
+[indexterm2 native_handle..windows::object_handle_service]
+Get the native handle implementation.
+
+
+ native_handle_type native_handle(
+ implementation_type & impl);
+
+
+
+[endsect]
+
+
+
+[section:native_handle_type windows::object_handle_service::native_handle_type]
+
+[indexterm2 native_handle_type..windows::object_handle_service]
+The native handle type.
+
+
+ typedef implementation_defined native_handle_type;
+
+
+
+[heading Requirements]
+
+[*Header: ][^boost/asio/windows/object_handle_service.hpp]
+
+[*Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:object_handle_service windows::object_handle_service::object_handle_service]
+
+[indexterm2 object_handle_service..windows::object_handle_service]
+Construct a new object handle service for the specified [link boost_asio.reference.io_service `io_service`].
+
+
+ object_handle_service(
+ boost::asio::io_service & io_service);
+
+
+
+[endsect]
+
+
+
+[section:wait windows::object_handle_service::wait]
+
+[indexterm2 wait..windows::object_handle_service]
+
+ void wait(
+ implementation_type & impl,
+ boost::system::error_code & ec);
+
+
+
+[endsect]
+
+
+
+[endsect]
+
[section:windows__overlapped_ptr windows::overlapped_ptr]
Modified: branches/release/libs/asio/doc/reference.xsl
==============================================================================
--- branches/release/libs/asio/doc/reference.xsl (original)
+++ branches/release/libs/asio/doc/reference.xsl 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<!--
- Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ Copyright (c) 2003-2012 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)
@@ -26,7 +26,7 @@
-->
<xsl:template match="/doxygen">
<xsl:text>[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -60,6 +60,7 @@
[include requirements/IoControlCommand.qbk]
[include requirements/IoObjectService.qbk]
[include requirements/MutableBufferSequence.qbk]
+[include requirements/ObjectHandleService.qbk]
[include requirements/Protocol.qbk]
[include requirements/RandomAccessHandleService.qbk]
[include requirements/RawSocketService.qbk]
@@ -85,7 +86,9 @@
[include requirements/SyncWriteStream.qbk]
[include requirements/TimeTraits.qbk]
[include requirements/TimerService.qbk]
+[include requirements/WaitableTimerService.qbk]
[include requirements/WaitHandler.qbk]
+[include requirements/WaitTraits.qbk]
[include requirements/WriteHandler.qbk]
</xsl:text>
@@ -732,6 +735,15 @@
<xsl:when test="contains($file, 'boost/asio/ssl')">
<xsl:text>[^boost/asio/ssl.hpp]</xsl:text>
</xsl:when>
+ <xsl:when test="contains($file, 'boost/asio/high_resolution_timer')">
+ <xsl:text>None</xsl:text>
+ </xsl:when>
+ <xsl:when test="contains($file, 'boost/asio/steady_timer')">
+ <xsl:text>None</xsl:text>
+ </xsl:when>
+ <xsl:when test="contains($file, 'boost/asio/system_timer')">
+ <xsl:text>None</xsl:text>
+ </xsl:when>
<xsl:otherwise>
<xsl:text>[^boost/asio.hpp]</xsl:text>
</xsl:otherwise>
@@ -1405,6 +1417,9 @@
<xsl:when test="declname = 'ByteType'">
<xsl:value-of select="declname"/>
</xsl:when>
+ <xsl:when test="declname = 'Clock'">
+ <xsl:value-of select="declname"/>
+ </xsl:when>
<xsl:when test="declname = 'CompletionCondition'">
<xsl:value-of select="declname"/>
</xsl:when>
Modified: branches/release/libs/asio/doc/requirements.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements.qbk (original)
+++ branches/release/libs/asio/doc/requirements.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/AcceptHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/AcceptHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/AcceptHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/AsyncRandomAccessReadDevice.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/AsyncRandomAccessReadDevice.qbk (original)
+++ branches/release/libs/asio/doc/requirements/AsyncRandomAccessReadDevice.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/AsyncRandomAccessWriteDevice.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/AsyncRandomAccessWriteDevice.qbk (original)
+++ branches/release/libs/asio/doc/requirements/AsyncRandomAccessWriteDevice.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/AsyncReadStream.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/AsyncReadStream.qbk (original)
+++ branches/release/libs/asio/doc/requirements/AsyncReadStream.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/AsyncWriteStream.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/AsyncWriteStream.qbk (original)
+++ branches/release/libs/asio/doc/requirements/AsyncWriteStream.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/CompletionHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/CompletionHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/CompletionHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ComposedConnectHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ComposedConnectHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ComposedConnectHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ConnectHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ConnectHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ConnectHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ConstBufferSequence.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ConstBufferSequence.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ConstBufferSequence.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ConvertibleToConstBuffer.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ConvertibleToConstBuffer.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ConvertibleToConstBuffer.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ConvertibleToMutableBuffer.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ConvertibleToMutableBuffer.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ConvertibleToMutableBuffer.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/DatagramSocketService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/DatagramSocketService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/DatagramSocketService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/DescriptorService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/DescriptorService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/DescriptorService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/Endpoint.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/Endpoint.qbk (original)
+++ branches/release/libs/asio/doc/requirements/Endpoint.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/GettableSerialPortOption.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/GettableSerialPortOption.qbk (original)
+++ branches/release/libs/asio/doc/requirements/GettableSerialPortOption.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/GettableSocketOption.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/GettableSocketOption.qbk (original)
+++ branches/release/libs/asio/doc/requirements/GettableSocketOption.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/HandleService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/HandleService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/HandleService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/Handler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/Handler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/Handler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/HandshakeHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/HandshakeHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/HandshakeHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/InternetProtocol.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/InternetProtocol.qbk (original)
+++ branches/release/libs/asio/doc/requirements/InternetProtocol.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/IoControlCommand.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/IoControlCommand.qbk (original)
+++ branches/release/libs/asio/doc/requirements/IoControlCommand.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/IoObjectService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/IoObjectService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/IoObjectService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/MutableBufferSequence.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/MutableBufferSequence.qbk (original)
+++ branches/release/libs/asio/doc/requirements/MutableBufferSequence.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/doc/requirements/ObjectHandleService.qbk
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/doc/requirements/ObjectHandleService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,46 @@
+[/
+ / Copyright (c) 2003-2012 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)
+ /]
+
+[section:ObjectHandleService Object handle service requirements]
+
+An object handle service must meet the requirements for a [link
+boost_asio.reference.HandleService handle service], as well as the additional
+requirements listed below.
+
+In the table below, `X` denotes an object handle service class, `a` denotes a
+value of type `X`, `b` denotes a value of type `X::implementation_type`, `ec`
+denotes a value of type `error_code`, and `wh` denotes a value meeting [link
+boost_asio.reference.WaitHandler `WaitHandler`] requirements.
+
+[table ObjectHandleService requirements
+ [[expression] [return type] [assertion/note\npre/post-condition]]
+ [
+ [`a.wait(b, ec);`]
+ [`error_code`]
+ [
+ pre: `a.is_open(b)`.\n
+ \n
+ Synchronously waits for the object represented by handle `b` to become
+ signalled.
+ ]
+ ]
+ [
+ [`a.async_wait(b, wh);`]
+ [`void`]
+ [
+ pre: `a.is_open(b)`.\n
+ \n
+ Initiates an asynchronous operation to wait for the object represented by
+ handle `b` to become signalled. The operation is performed via the
+ `io_service` object `a.get_io_service()` and behaves according to [link
+ boost_asio.reference.asynchronous_operations asynchronous operation]
+ requirements.
+ ]
+ ]
+]
+
+[endsect]
Modified: branches/release/libs/asio/doc/requirements/Protocol.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/Protocol.qbk (original)
+++ branches/release/libs/asio/doc/requirements/Protocol.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/RandomAccessHandleService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/RandomAccessHandleService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/RandomAccessHandleService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/RawSocketService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/RawSocketService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/RawSocketService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ReadHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ReadHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ReadHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ResolveHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ResolveHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ResolveHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ResolverService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ResolverService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ResolverService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SeqPacketSocketService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SeqPacketSocketService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SeqPacketSocketService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SerialPortService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SerialPortService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SerialPortService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/Service.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/Service.qbk (original)
+++ branches/release/libs/asio/doc/requirements/Service.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SettableSerialPortOption.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SettableSerialPortOption.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SettableSerialPortOption.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SettableSocketOption.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SettableSocketOption.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SettableSocketOption.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/ShutdownHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/ShutdownHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/ShutdownHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SignalHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SignalHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SignalHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SignalSetService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SignalSetService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SignalSetService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SocketAcceptorService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SocketAcceptorService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SocketAcceptorService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SocketService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SocketService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SocketService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/StreamDescriptorService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/StreamDescriptorService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/StreamDescriptorService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/StreamHandleService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/StreamHandleService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/StreamHandleService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/StreamSocketService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/StreamSocketService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/StreamSocketService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SyncRandomAccessReadDevice.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SyncRandomAccessReadDevice.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SyncRandomAccessReadDevice.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SyncRandomAccessWriteDevice.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SyncRandomAccessWriteDevice.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SyncRandomAccessWriteDevice.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SyncReadStream.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SyncReadStream.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SyncReadStream.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/SyncWriteStream.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/SyncWriteStream.qbk (original)
+++ branches/release/libs/asio/doc/requirements/SyncWriteStream.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/TimeTraits.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/TimeTraits.qbk (original)
+++ branches/release/libs/asio/doc/requirements/TimeTraits.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/TimerService.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/TimerService.qbk (original)
+++ branches/release/libs/asio/doc/requirements/TimerService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/WaitHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/WaitHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/WaitHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/doc/requirements/WaitTraits.qbk
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/doc/requirements/WaitTraits.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,26 @@
+[/
+ / Copyright (c) 2003-2012 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)
+ /]
+
+[section:WaitTraits Wait traits requirements]
+
+In the table below, `X` denotes a wait traits class for clock type `Clock`,
+where `Clock` meets the C++11 type requirements for a clock, and `d` denotes
+a value of type `Clock::duration`.
+
+[table WaitTraits requirements
+ [[expression] [return type] [assertion/note\npre/post-condition]]
+ [
+ [`X::to_wait_duration(d);`]
+ [`Clock::duration`]
+ [
+ Returns the maximum duration to be used for an individual,
+ implementation-defined wait operation.
+ ]
+ ]
+]
+
+[endsect]
Added: branches/release/libs/asio/doc/requirements/WaitableTimerService.qbk
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/doc/requirements/WaitableTimerService.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,104 @@
+[/
+ / Copyright (c) 2003-2012 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)
+ /]
+
+[section:WaitableTimerService Waitable timer service requirements]
+
+A waitable timer service must meet the requirements for an [link
+boost_asio.reference.IoObjectService I/O object service], as well as the
+additional requirements listed below.
+
+In the table below, `X` denotes a waitable timer service class for clock type
+`Clock`, where `Clock` meets the C++11 clock type requirements, `a` denotes a
+value of type `X`, `b` denotes a value of type `X::implementation_type`, `t`
+denotes a value of type `Clock::time_point`, `d` denotes a value of type
+`Clock::duration`, `e` denotes a value of type `error_code`, and `h` denotes a
+value meeting [link boost_asio.reference.WaitHandler `WaitHandler`] requirements.
+
+[table WaitableTimerService requirements
+ [[expression] [return type] [assertion/note\npre/post-condition]]
+ [
+ [`a.destroy(b);`]
+ []
+ [
+ From [link boost_asio.reference.IoObjectService IoObjectService]
+ requirements. Implicitly cancels asynchronous wait operations, as if by
+ calling `a.cancel(b, e)`.
+ ]
+ ]
+ [
+ [``
+ a.cancel(b, e);
+ ``]
+ [`size_t`]
+ [
+ Causes any outstanding asynchronous wait operations to complete as soon
+ as possible. Handlers for cancelled operations shall be passed the error
+ code `error::operation_aborted`. Sets `e` to indicate success or failure.
+ Returns the number of operations that were cancelled.
+ ]
+ ]
+ [
+ [`a.expires_at(b);`]
+ [`Clock::time_point`]
+ []
+ ]
+ [
+ [``
+ a.expires_at(b, t, e);
+ ``]
+ [`size_t`]
+ [
+ Implicitly cancels asynchronous wait operations, as if by calling
+ `a.cancel(b, e)`. Returns the number of operations that were cancelled.\n
+ post: `a.expires_at(b) == t`.
+ ]
+ ]
+ [
+ [`a.expires_from_now(b);`]
+ [`Clock::duration`]
+ [
+ Returns a value equivalent to `a.expires_at(b) - Clock::now()`.
+ ]
+ ]
+ [
+ [``
+ a.expires_from_now(b, d, e);
+ ``]
+ [`size_t`]
+ [
+ Equivalent to `a.expires_at(b, Clock::now() + d, e)`.
+ ]
+ ]
+ [
+ [``
+ a.wait(b, e);
+ ``]
+ [`error_code`]
+ [
+ Sets `e` to indicate success or failure. Returns `e`.\n
+ post: `!!e || !(Clock::now() < a.expires_at(b))`.
+ ]
+ ]
+ [
+ [``
+ a.async_wait(b, h);
+ ``]
+ []
+ [
+ Initiates an asynchronous wait operation that is performed via the
+ `io_service` object `a.get_io_service()` and behaves according to [link
+ boost_asio.reference.asynchronous_operations asynchronous operation]
+ requirements.\n
+ \n
+ The handler shall be posted for execution only if the condition
+ `!!ec || !(Clock::now() < a.expires_at(b))`
+ holds, where `ec` is the error code to be passed to the handler.
+ ]
+ ]
+]
+
+[endsect]
Modified: branches/release/libs/asio/doc/requirements/WriteHandler.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/WriteHandler.qbk (original)
+++ branches/release/libs/asio/doc/requirements/WriteHandler.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/requirements/asynchronous_operations.qbk
==============================================================================
--- branches/release/libs/asio/doc/requirements/asynchronous_operations.qbk (original)
+++ branches/release/libs/asio/doc/requirements/asynchronous_operations.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/std_exception_dox.txt
==============================================================================
--- branches/release/libs/asio/doc/std_exception_dox.txt (original)
+++ branches/release/libs/asio/doc/std_exception_dox.txt 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/tutorial.qbk
==============================================================================
--- branches/release/libs/asio/doc/tutorial.qbk (original)
+++ branches/release/libs/asio/doc/tutorial.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
@@ -142,7 +142,7 @@
``''''''``// timer.cpp
``''''''``// ~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -242,7 +242,7 @@
``''''''``// timer.cpp
``''''''``// ~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -390,7 +390,7 @@
``''''''``// timer.cpp
``''''''``// ~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -551,7 +551,7 @@
``''''''``// timer.cpp
``''''''``// ~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -751,7 +751,7 @@
``''''''``// timer.cpp
``''''''``// ~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -959,7 +959,7 @@
``''''''``// client.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -1118,7 +1118,7 @@
``''''''``// server.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -1370,7 +1370,7 @@
``''''''``// server.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -1591,7 +1591,7 @@
``''''''``// client.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -1734,7 +1734,7 @@
``''''''``// server.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -1952,7 +1952,7 @@
``''''''``// server.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
@@ -2231,7 +2231,7 @@
``''''''``// server.cpp
``''''''``// ~~~~~~~~~~
``''''''``//
- ``''''''``// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ ``''''''``// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/tutorial.xsl
==============================================================================
--- branches/release/libs/asio/doc/tutorial.xsl (original)
+++ branches/release/libs/asio/doc/tutorial.xsl 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<!--
- Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ Copyright (c) 2003-2012 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)
@@ -20,7 +20,7 @@
<xsl:template match="/doxygen">
<xsl:text>[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/doc/using.qbk
==============================================================================
--- branches/release/libs/asio/doc/using.qbk (original)
+++ branches/release/libs/asio/doc/using.qbk 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
[/
- / Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+ / Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/allocation/Jamfile
==============================================================================
--- branches/release/libs/asio/example/allocation/Jamfile (original)
+++ branches/release/libs/asio/example/allocation/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/allocation/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/allocation/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/allocation/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/allocation/server.cpp
==============================================================================
--- branches/release/libs/asio/example/allocation/server.cpp (original)
+++ branches/release/libs/asio/example/allocation/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/buffers/Jamfile
==============================================================================
--- branches/release/libs/asio/example/buffers/Jamfile (original)
+++ branches/release/libs/asio/example/buffers/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/buffers/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/buffers/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/buffers/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/buffers/reference_counted.cpp
==============================================================================
--- branches/release/libs/asio/example/buffers/reference_counted.cpp (original)
+++ branches/release/libs/asio/example/buffers/reference_counted.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reference_counted.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/Jamfile
==============================================================================
--- branches/release/libs/asio/example/chat/Jamfile (original)
+++ branches/release/libs/asio/example/chat/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/chat/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/chat/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/chat_client.cpp
==============================================================================
--- branches/release/libs/asio/example/chat/chat_client.cpp (original)
+++ branches/release/libs/asio/example/chat/chat_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// chat_client.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/chat_message.hpp
==============================================================================
--- branches/release/libs/asio/example/chat/chat_message.hpp (original)
+++ branches/release/libs/asio/example/chat/chat_message.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// chat_message.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/chat_server.cpp
==============================================================================
--- branches/release/libs/asio/example/chat/chat_server.cpp (original)
+++ branches/release/libs/asio/example/chat/chat_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// chat_server.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/chat/posix_chat_client.cpp
==============================================================================
--- branches/release/libs/asio/example/chat/posix_chat_client.cpp (original)
+++ branches/release/libs/asio/example/chat/posix_chat_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// posix_chat_client.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/Jamfile
==============================================================================
--- branches/release/libs/asio/example/echo/Jamfile (original)
+++ branches/release/libs/asio/example/echo/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/echo/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/echo/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/async_tcp_echo_server.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/async_tcp_echo_server.cpp (original)
+++ branches/release/libs/asio/example/echo/async_tcp_echo_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// async_tcp_echo_server.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/async_udp_echo_server.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/async_udp_echo_server.cpp (original)
+++ branches/release/libs/asio/example/echo/async_udp_echo_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// async_udp_echo_server.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/blocking_tcp_echo_client.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/blocking_tcp_echo_client.cpp (original)
+++ branches/release/libs/asio/example/echo/blocking_tcp_echo_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_tcp_echo_client.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/blocking_tcp_echo_server.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/blocking_tcp_echo_server.cpp (original)
+++ branches/release/libs/asio/example/echo/blocking_tcp_echo_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_tcp_echo_server.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/blocking_udp_echo_client.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/blocking_udp_echo_client.cpp (original)
+++ branches/release/libs/asio/example/echo/blocking_udp_echo_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_udp_echo_client.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/echo/blocking_udp_echo_server.cpp
==============================================================================
--- branches/release/libs/asio/example/echo/blocking_udp_echo_server.cpp (original)
+++ branches/release/libs/asio/example/echo/blocking_udp_echo_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_udp_echo_server.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/fork/Jamfile
==============================================================================
--- branches/release/libs/asio/example/fork/Jamfile (original)
+++ branches/release/libs/asio/example/fork/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/fork/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/fork/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/fork/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/fork/daemon.cpp
==============================================================================
--- branches/release/libs/asio/example/fork/daemon.cpp (original)
+++ branches/release/libs/asio/example/fork/daemon.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// daemon.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/fork/process_per_connection.cpp
==============================================================================
--- branches/release/libs/asio/example/fork/process_per_connection.cpp (original)
+++ branches/release/libs/asio/example/fork/process_per_connection.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// process_per_connection.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/client/Jamfile
==============================================================================
--- branches/release/libs/asio/example/http/client/Jamfile (original)
+++ branches/release/libs/asio/example/http/client/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/client/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/http/client/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/http/client/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/client/async_client.cpp
==============================================================================
--- branches/release/libs/asio/example/http/client/async_client.cpp (original)
+++ branches/release/libs/asio/example/http/client/async_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// async_client.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/client/sync_client.cpp
==============================================================================
--- branches/release/libs/asio/example/http/client/sync_client.cpp (original)
+++ branches/release/libs/asio/example/http/client/sync_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// sync_client.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/doc_root/data_1K.html
==============================================================================
--- branches/release/libs/asio/example/http/doc_root/data_1K.html (original)
+++ branches/release/libs/asio/example/http/doc_root/data_1K.html 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/doc_root/data_2K.html
==============================================================================
--- branches/release/libs/asio/example/http/doc_root/data_2K.html (original)
+++ branches/release/libs/asio/example/http/doc_root/data_2K.html 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/doc_root/data_4K.html
==============================================================================
--- branches/release/libs/asio/example/http/doc_root/data_4K.html (original)
+++ branches/release/libs/asio/example/http/doc_root/data_4K.html 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/doc_root/data_8K.html
==============================================================================
--- branches/release/libs/asio/example/http/doc_root/data_8K.html (original)
+++ branches/release/libs/asio/example/http/doc_root/data_8K.html 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/Jamfile
==============================================================================
--- branches/release/libs/asio/example/http/server/Jamfile (original)
+++ branches/release/libs/asio/example/http/server/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/http/server/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/http/server/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/connection.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/connection.cpp (original)
+++ branches/release/libs/asio/example/http/server/connection.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/connection.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/connection.hpp (original)
+++ branches/release/libs/asio/example/http/server/connection.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/connection_manager.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/connection_manager.cpp (original)
+++ branches/release/libs/asio/example/http/server/connection_manager.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection_manager.cpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/connection_manager.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/connection_manager.hpp (original)
+++ branches/release/libs/asio/example/http/server/connection_manager.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection_manager.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/header.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/header.hpp (original)
+++ branches/release/libs/asio/example/http/server/header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// header.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/main.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/main.cpp (original)
+++ branches/release/libs/asio/example/http/server/main.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// main.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/mime_types.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/mime_types.cpp (original)
+++ branches/release/libs/asio/example/http/server/mime_types.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/mime_types.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/mime_types.hpp (original)
+++ branches/release/libs/asio/example/http/server/mime_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/reply.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/reply.cpp (original)
+++ branches/release/libs/asio/example/http/server/reply.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/reply.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/reply.hpp (original)
+++ branches/release/libs/asio/example/http/server/reply.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/request.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/request.hpp (original)
+++ branches/release/libs/asio/example/http/server/request.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/request_handler.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/request_handler.cpp (original)
+++ branches/release/libs/asio/example/http/server/request_handler.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/request_handler.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/request_handler.hpp (original)
+++ branches/release/libs/asio/example/http/server/request_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/request_parser.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/request_parser.cpp (original)
+++ branches/release/libs/asio/example/http/server/request_parser.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/request_parser.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/request_parser.hpp (original)
+++ branches/release/libs/asio/example/http/server/request_parser.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/server.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server/server.cpp (original)
+++ branches/release/libs/asio/example/http/server/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server/server.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server/server.hpp (original)
+++ branches/release/libs/asio/example/http/server/server.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/Jamfile
==============================================================================
--- branches/release/libs/asio/example/http/server2/Jamfile (original)
+++ branches/release/libs/asio/example/http/server2/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/http/server2/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/http/server2/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/connection.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/connection.cpp (original)
+++ branches/release/libs/asio/example/http/server2/connection.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/connection.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/connection.hpp (original)
+++ branches/release/libs/asio/example/http/server2/connection.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/header.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/header.hpp (original)
+++ branches/release/libs/asio/example/http/server2/header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// header.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/io_service_pool.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/io_service_pool.cpp (original)
+++ branches/release/libs/asio/example/http/server2/io_service_pool.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// io_service_pool.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/io_service_pool.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/io_service_pool.hpp (original)
+++ branches/release/libs/asio/example/http/server2/io_service_pool.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// io_service_pool.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/main.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/main.cpp (original)
+++ branches/release/libs/asio/example/http/server2/main.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// main.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/mime_types.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/mime_types.cpp (original)
+++ branches/release/libs/asio/example/http/server2/mime_types.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/mime_types.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/mime_types.hpp (original)
+++ branches/release/libs/asio/example/http/server2/mime_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/reply.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/reply.cpp (original)
+++ branches/release/libs/asio/example/http/server2/reply.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/reply.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/reply.hpp (original)
+++ branches/release/libs/asio/example/http/server2/reply.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/request.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/request.hpp (original)
+++ branches/release/libs/asio/example/http/server2/request.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/request_handler.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/request_handler.cpp (original)
+++ branches/release/libs/asio/example/http/server2/request_handler.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/request_handler.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/request_handler.hpp (original)
+++ branches/release/libs/asio/example/http/server2/request_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/request_parser.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/request_parser.cpp (original)
+++ branches/release/libs/asio/example/http/server2/request_parser.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/request_parser.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/request_parser.hpp (original)
+++ branches/release/libs/asio/example/http/server2/request_parser.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/server.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/server.cpp (original)
+++ branches/release/libs/asio/example/http/server2/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server2/server.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server2/server.hpp (original)
+++ branches/release/libs/asio/example/http/server2/server.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/Jamfile
==============================================================================
--- branches/release/libs/asio/example/http/server3/Jamfile (original)
+++ branches/release/libs/asio/example/http/server3/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/http/server3/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/http/server3/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/connection.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/connection.cpp (original)
+++ branches/release/libs/asio/example/http/server3/connection.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/connection.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/connection.hpp (original)
+++ branches/release/libs/asio/example/http/server3/connection.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/header.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/header.hpp (original)
+++ branches/release/libs/asio/example/http/server3/header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// header.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/main.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/main.cpp (original)
+++ branches/release/libs/asio/example/http/server3/main.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// main.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/mime_types.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/mime_types.cpp (original)
+++ branches/release/libs/asio/example/http/server3/mime_types.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/mime_types.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/mime_types.hpp (original)
+++ branches/release/libs/asio/example/http/server3/mime_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/reply.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/reply.cpp (original)
+++ branches/release/libs/asio/example/http/server3/reply.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/reply.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/reply.hpp (original)
+++ branches/release/libs/asio/example/http/server3/reply.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/request.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/request.hpp (original)
+++ branches/release/libs/asio/example/http/server3/request.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/request_handler.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/request_handler.cpp (original)
+++ branches/release/libs/asio/example/http/server3/request_handler.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/request_handler.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/request_handler.hpp (original)
+++ branches/release/libs/asio/example/http/server3/request_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_handler.hpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/request_parser.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/request_parser.cpp (original)
+++ branches/release/libs/asio/example/http/server3/request_parser.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/request_parser.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/request_parser.hpp (original)
+++ branches/release/libs/asio/example/http/server3/request_parser.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/server.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/server.cpp (original)
+++ branches/release/libs/asio/example/http/server3/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server3/server.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server3/server.hpp (original)
+++ branches/release/libs/asio/example/http/server3/server.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/Jamfile
==============================================================================
--- branches/release/libs/asio/example/http/server4/Jamfile (original)
+++ branches/release/libs/asio/example/http/server4/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/http/server4/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/http/server4/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/coroutine.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/coroutine.hpp (original)
+++ branches/release/libs/asio/example/http/server4/coroutine.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// coroutine.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/file_handler.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/file_handler.cpp (original)
+++ branches/release/libs/asio/example/http/server4/file_handler.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// file_handler.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/file_handler.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/file_handler.hpp (original)
+++ branches/release/libs/asio/example/http/server4/file_handler.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// file_handler.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/header.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/header.hpp (original)
+++ branches/release/libs/asio/example/http/server4/header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// header.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/main.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/main.cpp (original)
+++ branches/release/libs/asio/example/http/server4/main.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// main.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/mime_types.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/mime_types.cpp (original)
+++ branches/release/libs/asio/example/http/server4/mime_types.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/mime_types.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/mime_types.hpp (original)
+++ branches/release/libs/asio/example/http/server4/mime_types.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// mime_types.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/reply.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/reply.cpp (original)
+++ branches/release/libs/asio/example/http/server4/reply.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/reply.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/reply.hpp (original)
+++ branches/release/libs/asio/example/http/server4/reply.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// reply.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/request.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/request.hpp (original)
+++ branches/release/libs/asio/example/http/server4/request.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/request_parser.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/request_parser.cpp (original)
+++ branches/release/libs/asio/example/http/server4/request_parser.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/request_parser.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/request_parser.hpp (original)
+++ branches/release/libs/asio/example/http/server4/request_parser.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// request_parser.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/server.cpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/server.cpp (original)
+++ branches/release/libs/asio/example/http/server4/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/server.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/server.hpp (original)
+++ branches/release/libs/asio/example/http/server4/server.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/unyield.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/unyield.hpp (original)
+++ branches/release/libs/asio/example/http/server4/unyield.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// unyield.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/http/server4/yield.hpp
==============================================================================
--- branches/release/libs/asio/example/http/server4/yield.hpp (original)
+++ branches/release/libs/asio/example/http/server4/yield.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// yield.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/icmp/Jamfile
==============================================================================
--- branches/release/libs/asio/example/icmp/Jamfile (original)
+++ branches/release/libs/asio/example/icmp/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/icmp/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/icmp/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/icmp/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/icmp/icmp_header.hpp
==============================================================================
--- branches/release/libs/asio/example/icmp/icmp_header.hpp (original)
+++ branches/release/libs/asio/example/icmp/icmp_header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// icmp_header.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/icmp/ipv4_header.hpp
==============================================================================
--- branches/release/libs/asio/example/icmp/ipv4_header.hpp (original)
+++ branches/release/libs/asio/example/icmp/ipv4_header.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ipv4_header.hpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/icmp/ping.cpp
==============================================================================
--- branches/release/libs/asio/example/icmp/ping.cpp (original)
+++ branches/release/libs/asio/example/icmp/ping.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// ping.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/invocation/Jamfile
==============================================================================
--- branches/release/libs/asio/example/invocation/Jamfile (original)
+++ branches/release/libs/asio/example/invocation/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/invocation/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/invocation/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/invocation/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/invocation/prioritised_handlers.cpp
==============================================================================
--- branches/release/libs/asio/example/invocation/prioritised_handlers.cpp (original)
+++ branches/release/libs/asio/example/invocation/prioritised_handlers.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// prioritised_handlers.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/iostreams/Jamfile
==============================================================================
--- branches/release/libs/asio/example/iostreams/Jamfile (original)
+++ branches/release/libs/asio/example/iostreams/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/iostreams/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/iostreams/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/iostreams/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/iostreams/daytime_client.cpp
==============================================================================
--- branches/release/libs/asio/example/iostreams/daytime_client.cpp (original)
+++ branches/release/libs/asio/example/iostreams/daytime_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// daytime_client.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/iostreams/daytime_server.cpp
==============================================================================
--- branches/release/libs/asio/example/iostreams/daytime_server.cpp (original)
+++ branches/release/libs/asio/example/iostreams/daytime_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// daytime_server.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/iostreams/http_client.cpp
==============================================================================
--- branches/release/libs/asio/example/iostreams/http_client.cpp (original)
+++ branches/release/libs/asio/example/iostreams/http_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// sync_client.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/Jamfile
==============================================================================
--- branches/release/libs/asio/example/local/Jamfile (original)
+++ branches/release/libs/asio/example/local/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/local/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/local/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/connect_pair.cpp
==============================================================================
--- branches/release/libs/asio/example/local/connect_pair.cpp (original)
+++ branches/release/libs/asio/example/local/connect_pair.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connect_pair.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/iostream_client.cpp
==============================================================================
--- branches/release/libs/asio/example/local/iostream_client.cpp (original)
+++ branches/release/libs/asio/example/local/iostream_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_client.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/stream_client.cpp
==============================================================================
--- branches/release/libs/asio/example/local/stream_client.cpp (original)
+++ branches/release/libs/asio/example/local/stream_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_client.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/local/stream_server.cpp
==============================================================================
--- branches/release/libs/asio/example/local/stream_server.cpp (original)
+++ branches/release/libs/asio/example/local/stream_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_server.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/multicast/Jamfile
==============================================================================
--- branches/release/libs/asio/example/multicast/Jamfile (original)
+++ branches/release/libs/asio/example/multicast/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/multicast/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/multicast/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/multicast/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/multicast/receiver.cpp
==============================================================================
--- branches/release/libs/asio/example/multicast/receiver.cpp (original)
+++ branches/release/libs/asio/example/multicast/receiver.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// receiver.cpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/multicast/sender.cpp
==============================================================================
--- branches/release/libs/asio/example/multicast/sender.cpp (original)
+++ branches/release/libs/asio/example/multicast/sender.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// sender.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/nonblocking/Jamfile
==============================================================================
--- branches/release/libs/asio/example/nonblocking/Jamfile (original)
+++ branches/release/libs/asio/example/nonblocking/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/nonblocking/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/nonblocking/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/nonblocking/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/nonblocking/third_party_lib.cpp
==============================================================================
--- branches/release/libs/asio/example/nonblocking/third_party_lib.cpp (original)
+++ branches/release/libs/asio/example/nonblocking/third_party_lib.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// third_party_lib.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/porthopper/Jamfile
==============================================================================
--- branches/release/libs/asio/example/porthopper/Jamfile (original)
+++ branches/release/libs/asio/example/porthopper/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/porthopper/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/porthopper/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/porthopper/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/porthopper/client.cpp
==============================================================================
--- branches/release/libs/asio/example/porthopper/client.cpp (original)
+++ branches/release/libs/asio/example/porthopper/client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// client.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/porthopper/protocol.hpp
==============================================================================
--- branches/release/libs/asio/example/porthopper/protocol.hpp (original)
+++ branches/release/libs/asio/example/porthopper/protocol.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// protocol.hpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/porthopper/server.cpp
==============================================================================
--- branches/release/libs/asio/example/porthopper/server.cpp (original)
+++ branches/release/libs/asio/example/porthopper/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/Jamfile
==============================================================================
--- branches/release/libs/asio/example/serialization/Jamfile (original)
+++ branches/release/libs/asio/example/serialization/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/serialization/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/serialization/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/client.cpp
==============================================================================
--- branches/release/libs/asio/example/serialization/client.cpp (original)
+++ branches/release/libs/asio/example/serialization/client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// client.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/connection.hpp
==============================================================================
--- branches/release/libs/asio/example/serialization/connection.hpp (original)
+++ branches/release/libs/asio/example/serialization/connection.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connection.hpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/server.cpp
==============================================================================
--- branches/release/libs/asio/example/serialization/server.cpp (original)
+++ branches/release/libs/asio/example/serialization/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/serialization/stock.hpp
==============================================================================
--- branches/release/libs/asio/example/serialization/stock.hpp (original)
+++ branches/release/libs/asio/example/serialization/stock.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stock.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/Jamfile
==============================================================================
--- branches/release/libs/asio/example/services/Jamfile (original)
+++ branches/release/libs/asio/example/services/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/services/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/services/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/basic_logger.hpp
==============================================================================
--- branches/release/libs/asio/example/services/basic_logger.hpp (original)
+++ branches/release/libs/asio/example/services/basic_logger.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_logger.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/daytime_client.cpp
==============================================================================
--- branches/release/libs/asio/example/services/daytime_client.cpp (original)
+++ branches/release/libs/asio/example/services/daytime_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// daytime_client.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/logger.hpp
==============================================================================
--- branches/release/libs/asio/example/services/logger.hpp (original)
+++ branches/release/libs/asio/example/services/logger.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// logger.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/logger_service.cpp
==============================================================================
--- branches/release/libs/asio/example/services/logger_service.cpp (original)
+++ branches/release/libs/asio/example/services/logger_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// logger_service.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/logger_service.hpp
==============================================================================
--- branches/release/libs/asio/example/services/logger_service.hpp (original)
+++ branches/release/libs/asio/example/services/logger_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// logger_service.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/services/stream_socket_service.hpp
==============================================================================
--- branches/release/libs/asio/example/services/stream_socket_service.hpp (original)
+++ branches/release/libs/asio/example/services/stream_socket_service.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_socket_service.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/socks4/Jamfile
==============================================================================
--- branches/release/libs/asio/example/socks4/Jamfile (original)
+++ branches/release/libs/asio/example/socks4/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/socks4/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/socks4/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/socks4/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/socks4/socks4.hpp
==============================================================================
--- branches/release/libs/asio/example/socks4/socks4.hpp (original)
+++ branches/release/libs/asio/example/socks4/socks4.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// socks4.hpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/socks4/sync_client.cpp
==============================================================================
--- branches/release/libs/asio/example/socks4/sync_client.cpp (original)
+++ branches/release/libs/asio/example/socks4/sync_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// sync_client.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/ssl/Jamfile
==============================================================================
--- branches/release/libs/asio/example/ssl/Jamfile (original)
+++ branches/release/libs/asio/example/ssl/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/ssl/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/ssl/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/ssl/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/ssl/README
==============================================================================
--- branches/release/libs/asio/example/ssl/README (original)
+++ branches/release/libs/asio/example/ssl/README 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
-------------------------------------------------------------------------------
-Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/ssl/client.cpp
==============================================================================
--- branches/release/libs/asio/example/ssl/client.cpp (original)
+++ branches/release/libs/asio/example/ssl/client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// client.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/ssl/server.cpp
==============================================================================
--- branches/release/libs/asio/example/ssl/server.cpp (original)
+++ branches/release/libs/asio/example/ssl/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/Jamfile
==============================================================================
--- branches/release/libs/asio/example/timeouts/Jamfile (original)
+++ branches/release/libs/asio/example/timeouts/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/timeouts/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/timeouts/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/async_tcp_client.cpp
==============================================================================
--- branches/release/libs/asio/example/timeouts/async_tcp_client.cpp (original)
+++ branches/release/libs/asio/example/timeouts/async_tcp_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// async_tcp_client.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/blocking_tcp_client.cpp
==============================================================================
--- branches/release/libs/asio/example/timeouts/blocking_tcp_client.cpp (original)
+++ branches/release/libs/asio/example/timeouts/blocking_tcp_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_tcp_client.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/blocking_udp_client.cpp
==============================================================================
--- branches/release/libs/asio/example/timeouts/blocking_udp_client.cpp (original)
+++ branches/release/libs/asio/example/timeouts/blocking_udp_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// blocking_udp_client.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timeouts/server.cpp
==============================================================================
--- branches/release/libs/asio/example/timeouts/server.cpp (original)
+++ branches/release/libs/asio/example/timeouts/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timers/Jamfile
==============================================================================
--- branches/release/libs/asio/example/timers/Jamfile (original)
+++ branches/release/libs/asio/example/timers/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timers/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/timers/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/timers/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timers/tick_count_timer.cpp
==============================================================================
--- branches/release/libs/asio/example/timers/tick_count_timer.cpp (original)
+++ branches/release/libs/asio/example/timers/tick_count_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// tick_count_timer.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/timers/time_t_timer.cpp
==============================================================================
--- branches/release/libs/asio/example/timers/time_t_timer.cpp (original)
+++ branches/release/libs/asio/example/timers/time_t_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// time_t_timer.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/Jamfile
==============================================================================
--- branches/release/libs/asio/example/tutorial/Jamfile (original)
+++ branches/release/libs/asio/example/tutorial/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/tutorial/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/tutorial/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime1/client.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime1/client.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime1/client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// client.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime2/server.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime2/server.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime2/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime3/server.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime3/server.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime3/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime4/client.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime4/client.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime4/client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// client.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime5/server.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime5/server.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime5/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime6/server.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime6/server.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime6/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime7/server.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime7/server.cpp (original)
+++ branches/release/libs/asio/example/tutorial/daytime7/server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// server.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/daytime_dox.txt
==============================================================================
--- branches/release/libs/asio/example/tutorial/daytime_dox.txt (original)
+++ branches/release/libs/asio/example/tutorial/daytime_dox.txt 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
@@ -41,17 +41,17 @@
\until tcp::resolver::query
The list of endpoints is returned using an iterator of type
-boost::asio::ip::tcp::resolver::iterator. A default constructed
-boost::asio::ip::tcp::resolver::iterator object is used as the end iterator.
+boost::asio::ip::tcp::resolver::iterator. (Note that a default constructed
+boost::asio::ip::tcp::resolver::iterator object can be used as an end iterator.)
-\until tcp::resolver::iterator end;
+\until tcp::resolver::iterator
Now we create and connect the socket. The list of endpoints obtained above may
contain both IPv4 and IPv6 endpoints, so we need to try each of them until we
find one that works. This keeps the client program independent of a specific IP
-version.
+version. The boost::asio::connect() function does this for us automatically.
-\until throw
+\until boost::asio::connect
The connection is open. All we need to do now is read the response from the
daytime service.
Modified: branches/release/libs/asio/example/tutorial/index_dox.txt
==============================================================================
--- branches/release/libs/asio/example/tutorial/index_dox.txt (original)
+++ branches/release/libs/asio/example/tutorial/index_dox.txt 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer1/timer.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer1/timer.cpp (original)
+++ branches/release/libs/asio/example/tutorial/timer1/timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// timer.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer2/timer.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer2/timer.cpp (original)
+++ branches/release/libs/asio/example/tutorial/timer2/timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// timer.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer3/timer.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer3/timer.cpp (original)
+++ branches/release/libs/asio/example/tutorial/timer3/timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// timer.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer4/timer.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer4/timer.cpp (original)
+++ branches/release/libs/asio/example/tutorial/timer4/timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// timer.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer5/timer.cpp
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer5/timer.cpp (original)
+++ branches/release/libs/asio/example/tutorial/timer5/timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// timer.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/tutorial/timer_dox.txt
==============================================================================
--- branches/release/libs/asio/example/tutorial/timer_dox.txt (original)
+++ branches/release/libs/asio/example/tutorial/timer_dox.txt 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/windows/Jamfile
==============================================================================
--- branches/release/libs/asio/example/windows/Jamfile (original)
+++ branches/release/libs/asio/example/windows/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/windows/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/example/windows/Jamfile.v2 (original)
+++ branches/release/libs/asio/example/windows/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/example/windows/transmit_file.cpp
==============================================================================
--- branches/release/libs/asio/example/windows/transmit_file.cpp (original)
+++ branches/release/libs/asio/example/windows/transmit_file.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// transmit_file.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/Jamfile
==============================================================================
--- branches/release/libs/asio/test/Jamfile (original)
+++ branches/release/libs/asio/test/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/test/Jamfile.v2 (original)
+++ branches/release/libs/asio/test/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
@@ -77,6 +77,8 @@
[ link basic_stream_socket.cpp : $(USE_SELECT) : basic_stream_socket_select ]
[ link basic_streambuf.cpp ]
[ link basic_streambuf.cpp : $(USE_SELECT) : basic_streambuf_select ]
+ [ link basic_waitable_timer.cpp ]
+ [ link basic_waitable_timer.cpp : $(USE_SELECT) : basic_waitable_timer_select ]
[ run buffer.cpp ]
[ run buffer.cpp : : : $(USE_SELECT) : buffer_select ]
[ run buffered_read_stream.cpp ]
@@ -99,6 +101,8 @@
[ run deadline_timer.cpp : : : $(USE_SELECT) : deadline_timer_select ]
[ run error.cpp ]
[ run error.cpp : : : $(USE_SELECT) : error_select ]
+ [ link high_resolution_timer.cpp ]
+ [ link high_resolution_timer.cpp : $(USE_SELECT) : high_resolution_timer_select ]
[ run io_service.cpp ]
[ run io_service.cpp : : : $(USE_SELECT) : io_service_select ]
[ link ip/address.cpp : : ip_address ]
@@ -175,20 +179,34 @@
[ link socket_acceptor_service.cpp : $(USE_SELECT) : socket_acceptor_service_select ]
[ run socket_base.cpp ]
[ run socket_base.cpp : : : $(USE_SELECT) : socket_base_select ]
+ [ link steady_timer.cpp ]
+ [ link steady_timer.cpp : $(USE_SELECT) : steady_timer_select ]
[ run strand.cpp ]
[ run strand.cpp : : : $(USE_SELECT) : strand_select ]
[ link stream_socket_service.cpp ]
[ link stream_socket_service.cpp : $(USE_SELECT) : stream_socket_service_select ]
[ run streambuf.cpp ]
[ run streambuf.cpp : : : $(USE_SELECT) : streambuf_select ]
+ [ link system_timer.cpp ]
+ [ link system_timer.cpp : $(USE_SELECT) : system_timer_select ]
[ link time_traits.cpp ]
[ link time_traits.cpp : $(USE_SELECT) : time_traits_select ]
+ [ link wait_traits.cpp ]
+ [ link wait_traits.cpp : $(USE_SELECT) : wait_traits_select ]
+ [ link waitable_timer_service.cpp ]
+ [ link waitable_timer_service.cpp : $(USE_SELECT) : waitable_timer_service_select ]
[ link windows/basic_handle.cpp : : windows_basic_handle ]
[ link windows/basic_handle.cpp : $(USE_SELECT) : windows_basic_handle_select ]
+ [ link windows/basic_object_handle.cpp : : windows_basic_object_handle ]
+ [ link windows/basic_object_handle.cpp : $(USE_SELECT) : windows_basic_object_handle_select ]
[ link windows/basic_random_access_handle.cpp : : windows_basic_random_access_handle ]
[ link windows/basic_random_access_handle.cpp : $(USE_SELECT) : windows_basic_random_access_handle_select ]
[ link windows/basic_stream_handle.cpp : : windows_basic_stream_handle ]
[ link windows/basic_stream_handle.cpp : $(USE_SELECT) : windows_basic_stream_handle_select ]
+ [ link windows/object_handle.cpp : : windows_object_handle ]
+ [ link windows/object_handle.cpp : $(USE_SELECT) : windows_object_handle_select ]
+ [ link windows/object_handle_service.cpp : : windows_object_handle_service ]
+ [ link windows/object_handle_service.cpp : $(USE_SELECT) : windows_object_handle_service_select ]
[ link windows/overlapped_ptr.cpp : : windows_overlapped_ptr ]
[ link windows/overlapped_ptr.cpp : $(USE_SELECT) : windows_overlapped_ptr_select ]
[ link windows/random_access_handle.cpp : : windows_random_access_handle ]
Modified: branches/release/libs/asio/test/archetypes/gettable_socket_option.hpp
==============================================================================
--- branches/release/libs/asio/test/archetypes/gettable_socket_option.hpp (original)
+++ branches/release/libs/asio/test/archetypes/gettable_socket_option.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// gettable_socket_option.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/archetypes/io_control_command.hpp
==============================================================================
--- branches/release/libs/asio/test/archetypes/io_control_command.hpp (original)
+++ branches/release/libs/asio/test/archetypes/io_control_command.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// io_control_command.hpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/archetypes/settable_socket_option.hpp
==============================================================================
--- branches/release/libs/asio/test/archetypes/settable_socket_option.hpp (original)
+++ branches/release/libs/asio/test/archetypes/settable_socket_option.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// settable_socket_option.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_datagram_socket.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_datagram_socket.cpp (original)
+++ branches/release/libs/asio/test/basic_datagram_socket.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_datagram_socket.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_deadline_timer.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_deadline_timer.cpp (original)
+++ branches/release/libs/asio/test/basic_deadline_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_deadline_timer.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_raw_socket.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_raw_socket.cpp (original)
+++ branches/release/libs/asio/test/basic_raw_socket.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_raw_socket.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_seq_packet_socket.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_seq_packet_socket.cpp (original)
+++ branches/release/libs/asio/test/basic_seq_packet_socket.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_seq_packet_socket.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_serial_port.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_serial_port.cpp (original)
+++ branches/release/libs/asio/test/basic_serial_port.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_serial_port.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/libs/asio/test/basic_signal_set.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_signal_set.cpp (original)
+++ branches/release/libs/asio/test/basic_signal_set.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_signal_set.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_socket_acceptor.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_socket_acceptor.cpp (original)
+++ branches/release/libs/asio/test/basic_socket_acceptor.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_socket_acceptor.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_stream_socket.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_stream_socket.cpp (original)
+++ branches/release/libs/asio/test/basic_stream_socket.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_stream_socket.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/basic_streambuf.cpp
==============================================================================
--- branches/release/libs/asio/test/basic_streambuf.cpp (original)
+++ branches/release/libs/asio/test/basic_streambuf.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_streambuf.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/basic_waitable_timer.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/basic_waitable_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,26 @@
+//
+// basic_waitable_timer.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/basic_waitable_timer.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("basic_waitable_timer");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/buffer.cpp
==============================================================================
--- branches/release/libs/asio/test/buffer.cpp (original)
+++ branches/release/libs/asio/test/buffer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffer.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/buffered_read_stream.cpp
==============================================================================
--- branches/release/libs/asio/test/buffered_read_stream.cpp (original)
+++ branches/release/libs/asio/test/buffered_read_stream.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_read_stream.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/buffered_stream.cpp
==============================================================================
--- branches/release/libs/asio/test/buffered_stream.cpp (original)
+++ branches/release/libs/asio/test/buffered_stream.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_stream.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/buffered_write_stream.cpp
==============================================================================
--- branches/release/libs/asio/test/buffered_write_stream.cpp (original)
+++ branches/release/libs/asio/test/buffered_write_stream.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffered_write_stream.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/buffers_iterator.cpp
==============================================================================
--- branches/release/libs/asio/test/buffers_iterator.cpp (original)
+++ branches/release/libs/asio/test/buffers_iterator.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// buffers_iterator.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/completion_condition.cpp
==============================================================================
--- branches/release/libs/asio/test/completion_condition.cpp (original)
+++ branches/release/libs/asio/test/completion_condition.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// completion_condition.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/connect.cpp
==============================================================================
--- branches/release/libs/asio/test/connect.cpp (original)
+++ branches/release/libs/asio/test/connect.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connect.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/datagram_socket_service.cpp
==============================================================================
--- branches/release/libs/asio/test/datagram_socket_service.cpp (original)
+++ branches/release/libs/asio/test/datagram_socket_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// datagram_socket_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/deadline_timer.cpp
==============================================================================
--- branches/release/libs/asio/test/deadline_timer.cpp (original)
+++ branches/release/libs/asio/test/deadline_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// deadline_timer.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/deadline_timer_service.cpp
==============================================================================
--- branches/release/libs/asio/test/deadline_timer_service.cpp (original)
+++ branches/release/libs/asio/test/deadline_timer_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// deadline_timer_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/error.cpp
==============================================================================
--- branches/release/libs/asio/test/error.cpp (original)
+++ branches/release/libs/asio/test/error.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// error.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/high_resolution_timer.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/high_resolution_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,31 @@
+//
+// high_resolution_timer.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Prevent link dependency on the Boost.System library.
+#if !defined(BOOST_SYSTEM_NO_DEPRECATED)
+#define BOOST_SYSTEM_NO_DEPRECATED
+#endif // !defined(BOOST_SYSTEM_NO_DEPRECATED)
+
+// Test that header file is self-contained.
+#include <boost/asio/high_resolution_timer.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("high_resolution_timer");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/io_service.cpp
==============================================================================
--- branches/release/libs/asio/test/io_service.cpp (original)
+++ branches/release/libs/asio/test/io_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// io_service.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/address.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/address.cpp (original)
+++ branches/release/libs/asio/test/ip/address.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// address.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/address_v4.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/address_v4.cpp (original)
+++ branches/release/libs/asio/test/ip/address_v4.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// address_v4.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/address_v6.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/address_v6.cpp (original)
+++ branches/release/libs/asio/test/ip/address_v6.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// address_v6.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/basic_endpoint.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/basic_endpoint.cpp (original)
+++ branches/release/libs/asio/test/ip/basic_endpoint.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_endpoint.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/basic_resolver.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/basic_resolver.cpp (original)
+++ branches/release/libs/asio/test/ip/basic_resolver.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_resolver.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/basic_resolver_entry.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/basic_resolver_entry.cpp (original)
+++ branches/release/libs/asio/test/ip/basic_resolver_entry.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_resolver_entry.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/basic_resolver_iterator.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/basic_resolver_iterator.cpp (original)
+++ branches/release/libs/asio/test/ip/basic_resolver_iterator.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_resolver_iterator.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/basic_resolver_query.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/basic_resolver_query.cpp (original)
+++ branches/release/libs/asio/test/ip/basic_resolver_query.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_resolver_query.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/host_name.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/host_name.cpp (original)
+++ branches/release/libs/asio/test/ip/host_name.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// host_name.cpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/multicast.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/multicast.cpp (original)
+++ branches/release/libs/asio/test/ip/multicast.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// multicast.cpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/resolver_query_base.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/resolver_query_base.cpp (original)
+++ branches/release/libs/asio/test/ip/resolver_query_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// resolver_query_base.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/resolver_service.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/resolver_service.cpp (original)
+++ branches/release/libs/asio/test/ip/resolver_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// resolver_service.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/tcp.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/tcp.cpp (original)
+++ branches/release/libs/asio/test/ip/tcp.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// tcp.cpp
// ~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/udp.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/udp.cpp (original)
+++ branches/release/libs/asio/test/ip/udp.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// udp.cpp
// ~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/unicast.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/unicast.cpp (original)
+++ branches/release/libs/asio/test/ip/unicast.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// unicast.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ip/v6_only.cpp
==============================================================================
--- branches/release/libs/asio/test/ip/v6_only.cpp (original)
+++ branches/release/libs/asio/test/ip/v6_only.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// v6_only.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/is_read_buffered.cpp
==============================================================================
--- branches/release/libs/asio/test/is_read_buffered.cpp (original)
+++ branches/release/libs/asio/test/is_read_buffered.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// is_read_buffered.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/is_write_buffered.cpp
==============================================================================
--- branches/release/libs/asio/test/is_write_buffered.cpp (original)
+++ branches/release/libs/asio/test/is_write_buffered.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// is_write_buffered.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/test/latency/Jamfile.v2 (original)
+++ branches/release/libs/asio/test/latency/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/allocator.hpp
==============================================================================
--- branches/release/libs/asio/test/latency/allocator.hpp (original)
+++ branches/release/libs/asio/test/latency/allocator.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// allocator.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/coroutine.hpp
==============================================================================
--- branches/release/libs/asio/test/latency/coroutine.hpp (original)
+++ branches/release/libs/asio/test/latency/coroutine.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// coroutine.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/high_res_clock.hpp
==============================================================================
--- branches/release/libs/asio/test/latency/high_res_clock.hpp (original)
+++ branches/release/libs/asio/test/latency/high_res_clock.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// high_res_clock.hpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/tcp_client.cpp
==============================================================================
--- branches/release/libs/asio/test/latency/tcp_client.cpp (original)
+++ branches/release/libs/asio/test/latency/tcp_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// tcp_client.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/tcp_server.cpp
==============================================================================
--- branches/release/libs/asio/test/latency/tcp_server.cpp (original)
+++ branches/release/libs/asio/test/latency/tcp_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// tcp_server.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/udp_client.cpp
==============================================================================
--- branches/release/libs/asio/test/latency/udp_client.cpp (original)
+++ branches/release/libs/asio/test/latency/udp_client.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// udp_client.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/udp_server.cpp
==============================================================================
--- branches/release/libs/asio/test/latency/udp_server.cpp (original)
+++ branches/release/libs/asio/test/latency/udp_server.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// udp_server.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/unyield.hpp
==============================================================================
--- branches/release/libs/asio/test/latency/unyield.hpp (original)
+++ branches/release/libs/asio/test/latency/unyield.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// unyield.hpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/latency/yield.hpp
==============================================================================
--- branches/release/libs/asio/test/latency/yield.hpp (original)
+++ branches/release/libs/asio/test/latency/yield.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// yield.hpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/local/basic_endpoint.cpp
==============================================================================
--- branches/release/libs/asio/test/local/basic_endpoint.cpp (original)
+++ branches/release/libs/asio/test/local/basic_endpoint.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_endpoint.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/local/connect_pair.cpp
==============================================================================
--- branches/release/libs/asio/test/local/connect_pair.cpp (original)
+++ branches/release/libs/asio/test/local/connect_pair.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// connect_pair.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/local/datagram_protocol.cpp
==============================================================================
--- branches/release/libs/asio/test/local/datagram_protocol.cpp (original)
+++ branches/release/libs/asio/test/local/datagram_protocol.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// datagram_protocol.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/local/stream_protocol.cpp
==============================================================================
--- branches/release/libs/asio/test/local/stream_protocol.cpp (original)
+++ branches/release/libs/asio/test/local/stream_protocol.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_protocol.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/placeholders.cpp
==============================================================================
--- branches/release/libs/asio/test/placeholders.cpp (original)
+++ branches/release/libs/asio/test/placeholders.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// placeholders.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/posix/basic_descriptor.cpp
==============================================================================
--- branches/release/libs/asio/test/posix/basic_descriptor.cpp (original)
+++ branches/release/libs/asio/test/posix/basic_descriptor.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_descriptor.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/posix/basic_stream_descriptor.cpp
==============================================================================
--- branches/release/libs/asio/test/posix/basic_stream_descriptor.cpp (original)
+++ branches/release/libs/asio/test/posix/basic_stream_descriptor.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_stream_descriptor.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/posix/descriptor_base.cpp
==============================================================================
--- branches/release/libs/asio/test/posix/descriptor_base.cpp (original)
+++ branches/release/libs/asio/test/posix/descriptor_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// descriptor_base.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/posix/stream_descriptor.cpp
==============================================================================
--- branches/release/libs/asio/test/posix/stream_descriptor.cpp (original)
+++ branches/release/libs/asio/test/posix/stream_descriptor.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_descriptor.cpp
// ~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/posix/stream_descriptor_service.cpp
==============================================================================
--- branches/release/libs/asio/test/posix/stream_descriptor_service.cpp (original)
+++ branches/release/libs/asio/test/posix/stream_descriptor_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_descriptor_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/raw_socket_service.cpp
==============================================================================
--- branches/release/libs/asio/test/raw_socket_service.cpp (original)
+++ branches/release/libs/asio/test/raw_socket_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// raw_socket_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/read.cpp
==============================================================================
--- branches/release/libs/asio/test/read.cpp (original)
+++ branches/release/libs/asio/test/read.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read.cpp
// ~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/read_at.cpp
==============================================================================
--- branches/release/libs/asio/test/read_at.cpp (original)
+++ branches/release/libs/asio/test/read_at.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read_at.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/read_until.cpp
==============================================================================
--- branches/release/libs/asio/test/read_until.cpp (original)
+++ branches/release/libs/asio/test/read_until.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// read_until.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/seq_packet_socket_service.cpp
==============================================================================
--- branches/release/libs/asio/test/seq_packet_socket_service.cpp (original)
+++ branches/release/libs/asio/test/seq_packet_socket_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// seq_packet_socket_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/serial_port.cpp
==============================================================================
--- branches/release/libs/asio/test/serial_port.cpp (original)
+++ branches/release/libs/asio/test/serial_port.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/libs/asio/test/serial_port_base.cpp
==============================================================================
--- branches/release/libs/asio/test/serial_port_base.cpp (original)
+++ branches/release/libs/asio/test/serial_port_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port_base.cpp
// ~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/libs/asio/test/serial_port_service.cpp
==============================================================================
--- branches/release/libs/asio/test/serial_port_service.cpp (original)
+++ branches/release/libs/asio/test/serial_port_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// serial_port_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 Christopher M. Kohlhoff (chris at kohlhoff dot com)
// Copyright (c) 2008 Rep Invariant Systems, Inc. (info_at_[hidden])
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
Modified: branches/release/libs/asio/test/signal_set.cpp
==============================================================================
--- branches/release/libs/asio/test/signal_set.cpp (original)
+++ branches/release/libs/asio/test/signal_set.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// signal_set.cpp
// ~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/signal_set_service.cpp
==============================================================================
--- branches/release/libs/asio/test/signal_set_service.cpp (original)
+++ branches/release/libs/asio/test/signal_set_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// signal_set_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/socket_acceptor_service.cpp
==============================================================================
--- branches/release/libs/asio/test/socket_acceptor_service.cpp (original)
+++ branches/release/libs/asio/test/socket_acceptor_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// socket_acceptor_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/socket_base.cpp
==============================================================================
--- branches/release/libs/asio/test/socket_base.cpp (original)
+++ branches/release/libs/asio/test/socket_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// socket_base.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/Jamfile
==============================================================================
--- branches/release/libs/asio/test/ssl/Jamfile (original)
+++ branches/release/libs/asio/test/ssl/Jamfile 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/Jamfile.v2
==============================================================================
--- branches/release/libs/asio/test/ssl/Jamfile.v2 (original)
+++ branches/release/libs/asio/test/ssl/Jamfile.v2 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+# Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/basic_context.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/basic_context.cpp (original)
+++ branches/release/libs/asio/test/ssl/basic_context.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_context.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/context.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/context.cpp (original)
+++ branches/release/libs/asio/test/ssl/context.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// context.cpp
// ~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/context_base.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/context_base.cpp (original)
+++ branches/release/libs/asio/test/ssl/context_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// context_base.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/context_service.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/context_service.cpp (original)
+++ branches/release/libs/asio/test/ssl/context_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// context_service.cpp
// ~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/rfc2818_verification.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/rfc2818_verification.cpp (original)
+++ branches/release/libs/asio/test/ssl/rfc2818_verification.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// rfc2818_verification.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/stream.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/stream.cpp (original)
+++ branches/release/libs/asio/test/ssl/stream.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/stream_base.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/stream_base.cpp (original)
+++ branches/release/libs/asio/test/ssl/stream_base.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_base.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/ssl/stream_service.cpp
==============================================================================
--- branches/release/libs/asio/test/ssl/stream_service.cpp (original)
+++ branches/release/libs/asio/test/ssl/stream_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_service.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/steady_timer.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/steady_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,31 @@
+//
+// steady_timer.cpp
+// ~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Prevent link dependency on the Boost.System library.
+#if !defined(BOOST_SYSTEM_NO_DEPRECATED)
+#define BOOST_SYSTEM_NO_DEPRECATED
+#endif // !defined(BOOST_SYSTEM_NO_DEPRECATED)
+
+// Test that header file is self-contained.
+#include <boost/asio/steady_timer.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("steady_timer");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/strand.cpp
==============================================================================
--- branches/release/libs/asio/test/strand.cpp (original)
+++ branches/release/libs/asio/test/strand.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// strand.cpp
// ~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/stream_socket_service.cpp
==============================================================================
--- branches/release/libs/asio/test/stream_socket_service.cpp (original)
+++ branches/release/libs/asio/test/stream_socket_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_socket_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/streambuf.cpp
==============================================================================
--- branches/release/libs/asio/test/streambuf.cpp (original)
+++ branches/release/libs/asio/test/streambuf.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// streambuf.cpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/system_timer.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/system_timer.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,31 @@
+//
+// system_timer.cpp
+// ~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Prevent link dependency on the Boost.System library.
+#if !defined(BOOST_SYSTEM_NO_DEPRECATED)
+#define BOOST_SYSTEM_NO_DEPRECATED
+#endif // !defined(BOOST_SYSTEM_NO_DEPRECATED)
+
+// Test that header file is self-contained.
+#include <boost/asio/system_timer.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("system_timer");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/time_traits.cpp
==============================================================================
--- branches/release/libs/asio/test/time_traits.cpp (original)
+++ branches/release/libs/asio/test/time_traits.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// time_traits.cpp
// ~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/unit_test.hpp
==============================================================================
--- branches/release/libs/asio/test/unit_test.hpp (original)
+++ branches/release/libs/asio/test/unit_test.hpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// unit_test.hpp
// ~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/wait_traits.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/wait_traits.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,26 @@
+//
+// wait_traits.cpp
+// ~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/wait_traits.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("wait_traits");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Added: branches/release/libs/asio/test/waitable_timer_service.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/waitable_timer_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,26 @@
+//
+// waitable_timer_service.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/waitable_timer_service.hpp>
+
+#include "unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("waitable_timer_service");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/windows/basic_handle.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/basic_handle.cpp (original)
+++ branches/release/libs/asio/test/windows/basic_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_handle.cpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/windows/basic_object_handle.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/windows/basic_object_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,27 @@
+//
+// basic_object_handle.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/windows/basic_object_handle.hpp>
+
+#include <boost/asio.hpp>
+#include "../unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("windows/basic_object_handle");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/windows/basic_random_access_handle.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/basic_random_access_handle.cpp (original)
+++ branches/release/libs/asio/test/windows/basic_random_access_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_random_access_handle.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/windows/basic_stream_handle.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/basic_stream_handle.cpp (original)
+++ branches/release/libs/asio/test/windows/basic_stream_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// basic_stream_handle.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Added: branches/release/libs/asio/test/windows/object_handle.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/windows/object_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,117 @@
+//
+// object_handle.cpp
+// ~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/windows/object_handle.hpp>
+
+#include <boost/asio/io_service.hpp>
+#include "../unit_test.hpp"
+
+//------------------------------------------------------------------------------
+
+// windows_object_handle_compile test
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// The following test checks that all public member functions on the class
+// windows::object_handle compile and link correctly. Runtime failures are
+// ignored.
+
+namespace windows_object_handle_compile {
+
+void wait_handler(const boost::system::error_code&)
+{
+}
+
+void test()
+{
+#if defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+ using namespace boost::asio;
+ namespace win = boost::asio::windows;
+
+ try
+ {
+ io_service ios;
+ boost::system::error_code ec;
+
+ // basic_object_handle constructors.
+
+ win::object_handle handle1(ios);
+ HANDLE native_handle1 = INVALID_HANDLE_VALUE;
+ win::object_handle handle2(ios, native_handle1);
+
+#if defined(BOOST_ASIO_HAS_MOVE)
+ win::object_handle handle3(std::move(handle2));
+#endif // defined(BOOST_ASIO_HAS_MOVE)
+
+ // basic_object_handle operators.
+
+#if defined(BOOST_ASIO_HAS_MOVE)
+ handle1 = win::object_handle(ios);
+ handle1 = std::move(handle2);
+#endif // defined(BOOST_ASIO_HAS_MOVE)
+
+ // basic_io_object functions.
+
+ io_service& ios_ref = handle1.get_io_service();
+ (void)ios_ref;
+
+ // basic_handle functions.
+
+ win::object_handle::lowest_layer_type& lowest_layer
+ = handle1.lowest_layer();
+ (void)lowest_layer;
+
+ const win::object_handle& handle4 = handle1;
+ const win::object_handle::lowest_layer_type& lowest_layer2
+ = handle4.lowest_layer();
+ (void)lowest_layer2;
+
+ HANDLE native_handle2 = INVALID_HANDLE_VALUE;
+ handle1.assign(native_handle2);
+
+ bool is_open = handle1.is_open();
+ (void)is_open;
+
+ handle1.close();
+ handle1.close(ec);
+
+ win::object_handle::native_handle_type native_handle3
+ = handle1.native_handle();
+ (void)native_handle3;
+
+ handle1.cancel();
+ handle1.cancel(ec);
+
+ // basic_object_handle functions.
+
+ handle1.wait();
+ handle1.wait(ec);
+
+ handle1.async_wait(&wait_handler);
+ }
+ catch (std::exception&)
+ {
+ }
+#endif // defined(BOOST_ASIO_HAS_WINDOWS_OBJECT_HANDLE)
+}
+
+} // namespace windows_object_handle_compile
+
+//------------------------------------------------------------------------------
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("windows/object_handle");
+ test->add(BOOST_TEST_CASE(&windows_object_handle_compile::test));
+ return test;
+}
Added: branches/release/libs/asio/test/windows/object_handle_service.cpp
==============================================================================
--- (empty file)
+++ branches/release/libs/asio/test/windows/object_handle_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -0,0 +1,27 @@
+//
+// object_handle_service.cpp
+// ~~~~~~~~~~~~~~~~~~~~~~~~~
+//
+// Copyright (c) 2003-2012 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)
+//
+
+// Disable autolinking for unit tests.
+#if !defined(BOOST_ALL_NO_LIB)
+#define BOOST_ALL_NO_LIB 1
+#endif // !defined(BOOST_ALL_NO_LIB)
+
+// Test that header file is self-contained.
+#include <boost/asio/windows/object_handle_service.hpp>
+
+#include <boost/asio.hpp>
+#include "../unit_test.hpp"
+
+test_suite* init_unit_test_suite(int, char*[])
+{
+ test_suite* test = BOOST_TEST_SUITE("windows/object_handle_service");
+ test->add(BOOST_TEST_CASE(&null_test));
+ return test;
+}
Modified: branches/release/libs/asio/test/windows/overlapped_ptr.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/overlapped_ptr.cpp (original)
+++ branches/release/libs/asio/test/windows/overlapped_ptr.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// overlapped_ptr.cpp
// ~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/windows/random_access_handle.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/random_access_handle.cpp (original)
+++ branches/release/libs/asio/test/windows/random_access_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// random_access_handle.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/windows/random_access_handle_service.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/random_access_handle_service.cpp (original)
+++ branches/release/libs/asio/test/windows/random_access_handle_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// random_access_handle_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/windows/stream_handle.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/stream_handle.cpp (original)
+++ branches/release/libs/asio/test/windows/stream_handle.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_handle.cpp
// ~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/windows/stream_handle_service.cpp
==============================================================================
--- branches/release/libs/asio/test/windows/stream_handle_service.cpp (original)
+++ branches/release/libs/asio/test/windows/stream_handle_service.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// stream_handle_service.cpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/write.cpp
==============================================================================
--- branches/release/libs/asio/test/write.cpp (original)
+++ branches/release/libs/asio/test/write.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// write.cpp
// ~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Modified: branches/release/libs/asio/test/write_at.cpp
==============================================================================
--- branches/release/libs/asio/test/write_at.cpp (original)
+++ branches/release/libs/asio/test/write_at.cpp 2012-01-15 08:46:25 EST (Sun, 15 Jan 2012)
@@ -2,7 +2,7 @@
// write_at.cpp
// ~~~~~~~~~~~~
//
-// Copyright (c) 2003-2011 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2012 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)
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk